diff options
| -rw-r--r-- | docs/api.rst | 101 | ||||
| -rw-r--r-- | docs/conf.py | 8 | ||||
| -rw-r--r-- | docs/index.rst | 11 |
3 files changed, 112 insertions, 8 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..6002c78 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,101 @@ +:mod:`zope.security` API Revference +=================================== + +:mod:`zope.security.interfaces` +------------------------------- + +.. automodule:: zope.security.interfaces + +#xceptions +########## + + .. autointerface:: IUnauthorized + :members: + :member-order: bysource + + .. autoexception:: Unauthorized + + .. autointerface:: IForbidden + :members: + :member-order: bysource + + .. autoexception:: Forbidden + + .. autointerface:: IForbiddenAttribute + :members: + :member-order: bysource + + .. autoexception:: ForbiddenAttribute + +Utilities +########## + + .. autointerface:: ISecurityManagement + :members: + :member-order: bysource + + .. autointerface:: ISecurityChecking + :members: + :member-order: bysource + + .. autointerface:: ISecurityProxyFactory + :members: + :member-order: bysource + + .. autointerface:: IChecker + :members: + :member-order: bysource + + .. autointerface:: INameBasedChecker + :members: + :member-order: bysource + + .. autointerface:: ISecurityPolicy + :members: + :member-order: bysource + +Principals +########## + + .. autointerface:: IInteraction + :members: + :member-order: bysource + + .. autointerface:: IParticipation + :members: + :member-order: bysource + + .. autoexception:: NoInteraction + + .. autointerface:: IInteractionManagement + :members: + :member-order: bysource + + .. autointerface:: IPrincipal + :members: + :member-order: bysource + + .. autointerface:: IGroupAwarePrincipal + :members: + :member-order: bysource + + .. autointerface:: IGroupClosureAwarePrincipal + :members: + :member-order: bysource + + .. autointerface:: IGroup + :members: + :member-order: bysource + + .. autointerface:: IMemberGetterGroup + :members: + :member-order: bysource + + .. autointerface:: IMemberAwareGroup + :members: + :member-order: bysource + + .. autointerface:: IPermission + :members: + :member-order: bysource + diff --git a/docs/conf.py b/docs/conf.py index 6e0bc27..2bcdf49 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,13 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', + 'repoze.sphinx.autointerface', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/index.rst b/docs/index.rst index d3483a8..65c2ced 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,13 @@ -.. zope.security documentation master file, created by - sphinx-quickstart on Sun Dec 23 12:19:39 2012. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to zope.security's documentation! -========================================= +:mod:`zope.security` +==================== Contents: .. toctree:: :maxdepth: 2 + api + Indices and tables |