summaryrefslogtreecommitdiff
path: root/docs/source/pecan_rest.rst
diff options
context:
space:
mode:
authorJonathan LaCour <jonathan@cleverdevil.org>2011-03-06 14:21:51 -0500
committerJonathan LaCour <jonathan@cleverdevil.org>2011-03-06 14:21:51 -0500
commit5e34617839d8a49fdaed4f637e89f1ab07e6d412 (patch)
tree963c2ae73fc8a7fad3c55bab19569cb7ebe078c7 /docs/source/pecan_rest.rst
parent076814eea6c869f5e3d29206f62a92f9bc1e8812 (diff)
downloadpecan-5e34617839d8a49fdaed4f637e89f1ab07e6d412.tar.gz
Stubbing out API documentation for the entire framework. Now, we just
need more docstrings.
Diffstat (limited to 'docs/source/pecan_rest.rst')
-rw-r--r--docs/source/pecan_rest.rst11
1 files changed, 11 insertions, 0 deletions
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