diff options
| author | Chris McDonough <chrism@agendaless.com> | 2008-07-16 22:25:43 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2008-07-16 22:25:43 +0000 |
| commit | 9e3bdbce1063f67b2e927fec0677cf74095ea9ad (patch) | |
| tree | e55745c6710cd50c24450f6384dd6ba3b259e745 /docs/modules | |
| parent | 8b169d338e1ea6d07bc3cd0c9ff0b0ae91c56708 (diff) | |
| download | pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.tar.gz pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.tar.bz2 pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.zip | |
Rearrange into narrative and API sections; include README in narrative as "introduction".
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/index.rst | 20 | ||||
| -rw-r--r-- | docs/modules/push.rst | 9 | ||||
| -rw-r--r-- | docs/modules/router.rst | 10 | ||||
| -rw-r--r-- | docs/modules/security.rst | 43 | ||||
| -rw-r--r-- | docs/modules/template.rst | 10 | ||||
| -rw-r--r-- | docs/modules/view.rst | 9 |
6 files changed, 0 insertions, 101 deletions
diff --git a/docs/modules/index.rst b/docs/modules/index.rst deleted file mode 100644 index 496afc4c6..000000000 --- a/docs/modules/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _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/modules/push.rst b/docs/modules/push.rst deleted file mode 100644 index 3c7f835ce..000000000 --- a/docs/modules/push.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _push_module: - -:mod:`repoze.bfg.push` --------------------------- - -.. currentmodule:: repoze.bfg.push - -.. autoclass:: pushpage - diff --git a/docs/modules/router.rst b/docs/modules/router.rst deleted file mode 100644 index 84d51f73a..000000000 --- a/docs/modules/router.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _router_module: - -:mod:`repoze.bfg.router` ------------------------- - -.. automodule:: repoze.bfg.router - -.. autoclass:: Router - -.. autofunction:: repoze.bfg.router.make_app diff --git a/docs/modules/security.rst b/docs/modules/security.rst deleted file mode 100644 index 317a7b335..000000000 --- a/docs/modules/security.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. _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/modules/template.rst b/docs/modules/template.rst deleted file mode 100644 index 93b02a413..000000000 --- a/docs/modules/template.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _template_module: - -:mod:`repoze.bfg.template` --------------------------- - -.. currentmodule:: repoze.bfg.template - -.. autofunction:: render_template - -.. autofunction:: render_transform diff --git a/docs/modules/view.rst b/docs/modules/view.rst deleted file mode 100644 index 5d127a7a4..000000000 --- a/docs/modules/view.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _view_module: - -:mod:`repoze.bfg.view` ------------------------- - -.. currentmodule:: repoze.bfg.view - -.. autoclass:: View - :members: |