[Checkins] SVN: zope.security/trunk/ Add autodocs for interfaces module.

Tres Seaver cvs-admin at zope.org
Sun Dec 23 20:54:01 UTC 2012


Log message for revision 128862:
  Add autodocs for interfaces module.

Changed:
  _U  zope.security/trunk/
  A   zope.security/trunk/docs/api.rst
  U   zope.security/trunk/docs/conf.py
  U   zope.security/trunk/docs/index.rst

-=-
Added: zope.security/trunk/docs/api.rst
===================================================================
--- zope.security/trunk/docs/api.rst	                        (rev 0)
+++ zope.security/trunk/docs/api.rst	2012-12-23 20:54:01 UTC (rev 128862)
@@ -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
+

Modified: zope.security/trunk/docs/conf.py
===================================================================
--- zope.security/trunk/docs/conf.py	2012-12-23 20:54:00 UTC (rev 128861)
+++ zope.security/trunk/docs/conf.py	2012-12-23 20:54:01 UTC (rev 128862)
@@ -25,7 +25,13 @@
 
 # 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']

Modified: zope.security/trunk/docs/index.rst
===================================================================
--- zope.security/trunk/docs/index.rst	2012-12-23 20:54:00 UTC (rev 128861)
+++ zope.security/trunk/docs/index.rst	2012-12-23 20:54:01 UTC (rev 128862)
@@ -1,18 +1,15 @@
-.. 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.
+:mod:`zope.security`
+====================
 
-Welcome to zope.security's documentation!
-=========================================
-
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   api
 
 
+
 Indices and tables
 ==================
 



More information about the checkins mailing list