Stubbing out API documentation for the entire framework. Now, we just

need more docstrings.

11 files changed, 121 insertions, 0 deletions

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 534e169..c723417 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -79,6 +79,16 @@ docstrings here:
    :maxdepth: 2
    
    pecan_core.rst
+   pecan_configuration.rst
+   pecan_decorators.rst
+   pecan_default_config.rst
+   pecan_hooks.rst
+   pecan_jsonify.rst
+   pecan_rest.rst
+   pecan_routing.rst
+   pecan_secure.rst
+   pecan_templating.rst
+   pecan_util.rst
 
 
 License
diff --git a/docs/source/pecan_configuration.rst b/docs/source/pecan_configuration.rst
new file mode 100644
index 0000000..609635a
--- /dev/null
+++ b/docs/source/pecan_configuration.rst
@@ -0,0 +1,11 @@
+.. _pecan_configuration:
+
+:mod:`pecan.configuration` -- Pecan Configuration Engine
+========================================================
+
+The :mod:`pecan.configuration` module provides an implementation of a
+Python-based configuration engine for Pecan applications.
+
+.. automodule:: pecan.configuration
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_decorators.rst b/docs/source/pecan_decorators.rst
new file mode 100644
index 0000000..395f82a
--- /dev/null
+++ b/docs/source/pecan_decorators.rst
@@ -0,0 +1,11 @@
+.. _pecan_decorators:
+
+:mod:`pecan.decorators` -- Pecan Decorators
+===========================================
+
+The :mod:`pecan.decorators` module includes useful decorators for
+creating Pecan applications.
+
+.. automodule:: pecan.decorators
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_default_config.rst b/docs/source/pecan_default_config.rst
new file mode 100644
index 0000000..29337fc
--- /dev/null
+++ b/docs/source/pecan_default_config.rst
@@ -0,0 +1,11 @@
+.. _pecan_default_config:
+
+:mod:`pecan.default_config` -- Pecan Default Configuration
+==========================================================
+
+The :mod:`pecan.default_config` module contains the default configuration
+for all Pecan applications.
+
+.. automodule:: pecan.default_config
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_hooks.rst b/docs/source/pecan_hooks.rst
new file mode 100644
index 0000000..71587d7
--- /dev/null
+++ b/docs/source/pecan_hooks.rst
@@ -0,0 +1,12 @@
+.. _pecan_hooks:
+
+:mod:`pecan.hooks` -- Pecan Hooks
+=================================
+
+The :mod:`pecan.hooks` module includes support for creating Pecan
+``hooks`` which are a simple way to hook into the request processing
+of requests coming into your application to perform cross-cutting tasks.
+
+.. automodule:: pecan.hooks
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_jsonify.rst b/docs/source/pecan_jsonify.rst
new file mode 100644
index 0000000..7da09be
--- /dev/null
+++ b/docs/source/pecan_jsonify.rst
@@ -0,0 +1,11 @@
+.. _pecan_jsonify:
+
+:mod:`pecan.jsonify` -- Pecan ``JSON`` Support
+==============================================
+
+The :mod:`pecan.jsonify` module includes support for ``JSON`` rule 
+creation using generic functions.
+
+.. automodule:: pecan.jsonify
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_rest.rst b/docs/source/pecan_rest.rst
new file mode 100644
index 0000000..7b31bfd
--- /dev/null
+++ b/docs/source/pecan_rest.rst
@@ -0,0 +1,11 @@
+.. _pecan_rest:
+
+:mod:`pecan.rest` -- Pecan ``REST`` Controller
+==============================================
+
+The :mod:`pecan.rest` module includes support for writing fully
+``RESTful`` controllers in your Pecan application.
+
+.. automodule:: pecan.rest
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_routing.rst b/docs/source/pecan_routing.rst
new file mode 100644
index 0000000..47ffb6d
--- /dev/null
+++ b/docs/source/pecan_routing.rst
@@ -0,0 +1,11 @@
+.. _pecan_routing:
+
+:mod:`pecan.routing` -- Pecan Routing
+=====================================
+
+The :mod:`pecan.routing` module is the basis for all object-dispatch
+routing in Pecan.
+
+.. automodule:: pecan.routing
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_secure.rst b/docs/source/pecan_secure.rst
new file mode 100644
index 0000000..903845e
--- /dev/null
+++ b/docs/source/pecan_secure.rst
@@ -0,0 +1,11 @@
+.. _pecan_secure:
+
+:mod:`pecan.secure` -- Pecan Secure Controllers
+===============================================
+
+The :mod:`pecan.secure` module includes a basic framework for building
+security into your applications.
+
+.. automodule:: pecan.secure
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_templating.rst b/docs/source/pecan_templating.rst
new file mode 100644
index 0000000..17bb558
--- /dev/null
+++ b/docs/source/pecan_templating.rst
@@ -0,0 +1,12 @@
+.. _pecan_templating:
+
+:mod:`pecan.templating` -- Pecan Templating
+===========================================
+
+The :mod:`pecan.templating` module includes support for a variety of
+templating engines, plus the ability to create your own template
+engines.
+
+.. automodule:: pecan.templating
+  :members:
+  :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/pecan_util.rst b/docs/source/pecan_util.rst
new file mode 100644
index 0000000..f629d27
--- /dev/null
+++ b/docs/source/pecan_util.rst
@@ -0,0 +1,10 @@
+.. _pecan_util:
+
+:mod:`pecan.util` -- Pecan Utils
+================================
+
+The :mod:`pecan.util` module includes utility functions for Pecan.
+
+.. automodule:: pecan.util
+  :members:
+  :show-inheritance:
\ No newline at end of file