Rearrange into narrative and API sections; include README in narrative as "introduction".

6 files changed, 101 insertions, 0 deletions

diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 000000000..496afc4c6
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,20 @@
+.. _modules:
+
+API documentation
+=================
+
+:mod:`repoze.bfg`
+-----------------
+
+The :mod:`repoze.bfg` package contains the code nececessary to create
+and run a web application.
+
+.. toctree::
+   :maxdepth: 2
+
+   push
+   router
+   security
+   template
+   view
+
diff --git a/docs/api/push.rst b/docs/api/push.rst
new file mode 100644
index 000000000..3c7f835ce
--- /dev/null
+++ b/docs/api/push.rst
@@ -0,0 +1,9 @@
+.. _push_module:
+
+:mod:`repoze.bfg.push`
+--------------------------
+
+.. currentmodule:: repoze.bfg.push
+
+.. autoclass:: pushpage
+
diff --git a/docs/api/router.rst b/docs/api/router.rst
new file mode 100644
index 000000000..84d51f73a
--- /dev/null
+++ b/docs/api/router.rst
@@ -0,0 +1,10 @@
+.. _router_module:
+
+:mod:`repoze.bfg.router`
+------------------------
+
+.. automodule:: repoze.bfg.router
+
+.. autoclass:: Router
+
+.. autofunction:: repoze.bfg.router.make_app
diff --git a/docs/api/security.rst b/docs/api/security.rst
new file mode 100644
index 000000000..317a7b335
--- /dev/null
+++ b/docs/api/security.rst
@@ -0,0 +1,43 @@
+.. _security_module:
+
+:mod:`repoze.bfg.security`
+==========================
+
+.. automodule:: repoze.bfg.security
+
+  .. autofunction:: has_permission
+
+  .. attribute:: Everyone
+
+    The special principal id named 'Everyone'.  This principal id is
+    granted to all requests.  Its actual value is the string
+    'system.Everyone'.
+
+  .. attribute:: Authenticated
+
+    The special principal id named 'Authenticated'.  This principal id
+    is granted to all requests which contain any other non-Everyone
+    principal id (according to the security policy).  Its actual value
+    is the string 'system.Authenticated'.
+
+  .. attribute:: Allow
+
+    The ACE "action" (the first element in an ACE e.g. ``(Allow, Everyone,
+    'read')`` that means allow access.  A sequence of ACEs makes up an
+    ACL.  It is a string, and it's actual value is "Allow".
+
+  .. attribute:: Deny
+
+    The ACE "action" (the first element in an ACE e.g. ``(Deny,
+    'george', 'read')`` that means deny access.  A sequence of ACEs
+    makes up an ACL.  It is a string, and it's actual value is "Deny".
+
+  .. autoclass:: RemoteUserACLSecurityPolicy
+     :members:
+
+  .. autoclass:: Denied
+     :members:
+
+  .. autoclass:: Allowed
+     :members:
+
diff --git a/docs/api/template.rst b/docs/api/template.rst
new file mode 100644
index 000000000..93b02a413
--- /dev/null
+++ b/docs/api/template.rst
@@ -0,0 +1,10 @@
+.. _template_module:
+
+:mod:`repoze.bfg.template`
+--------------------------
+
+.. currentmodule:: repoze.bfg.template
+
+.. autofunction:: render_template
+
+.. autofunction:: render_transform
diff --git a/docs/api/view.rst b/docs/api/view.rst
new file mode 100644
index 000000000..5d127a7a4
--- /dev/null
+++ b/docs/api/view.rst
@@ -0,0 +1,9 @@
+.. _view_module:
+
+:mod:`repoze.bfg.view`
+------------------------
+
+.. currentmodule:: repoze.bfg.view
+
+.. autoclass:: View
+   :members: