[Checkins] SVN: zope.security/trunk/ Convert doctests in 'zope.security.zcml' into Sphinx doctest snppets.

[Tres Seaver]

Log message for revision 128879:
  Convert doctests in 'zope.security.zcml' into Sphinx doctest snppets.
  
  They are still tested under 'tox -e docs'.

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

-=-
Added: zope.security/trunk/docs/api/zcml.rst
===================================================================
--- zope.security/trunk/docs/api/zcml.rst	                        (rev 0)
+++ zope.security/trunk/docs/api/zcml.rst	2012-12-23 20:54:12 UTC (rev 128879)
@@ -0,0 +1,62 @@
+:mod:`zope.security.zcml`
+===============================
+
+.. autoclass:: zope.security.zcml.Permission
+   :members:
+   :member-order: bysource
+
+Let's look at an example:
+
+.. doctest::
+
+   >>> from zope.security.zcml import Permission
+   >>> class FauxContext(object):
+   ...     permission_mapping = {'zope.ManageCode':'zope.private'}
+   ...     _actions = []
+   ...     def action(self, **kws):
+   ...        self._actions.append(kws)
+   >>> context = FauxContext()
+   >>> field = Permission().bind(context)
+
+Let's test the fromUnicode method:
+
+.. doctest::
+
+   >>> field.fromUnicode(u'zope.foo')
+   'zope.foo'
+   >>> field.fromUnicode(u'zope.ManageCode')
+   'zope.private'
+
+Now let's see whether validation works alright
+
+.. doctest::
+
+   >>> field._validate('zope.ManageCode')
+   >>> context._actions[0]['args']
+   (None, 'zope.foo')
+   >>> field._validate('3 foo')
+   Traceback (most recent call last):
+   ...
+   InvalidId: 3 foo
+
+   zope.Public is always valid
+   >>> field._validate('zope.Public')
+
+
+.. autointerface:: zope.security.zcml.ISecurityPolicyDirective
+   :members:
+   :member-order: bysource
+
+.. autofunction:: zope.security.zcml.securityPolicy
+
+.. autointerface:: zope.security.zcml.IPermissionDirective
+   :members:
+   :member-order: bysource
+
+.. autofunction:: zope.security.zcml.permission
+
+.. autointerface:: zope.security.zcml.IRedefinePermission
+   :members:
+   :member-order: bysource
+
+.. autofunction:: zope.security.zcml.redefinePermission

Modified: zope.security/trunk/docs/index.rst
===================================================================
--- zope.security/trunk/docs/index.rst	2012-12-23 20:54:11 UTC (rev 128878)
+++ zope.security/trunk/docs/index.rst	2012-12-23 20:54:12 UTC (rev 128879)
@@ -17,9 +17,9 @@
    api/proxy
    api/simplepolicies
    api/testing
+   api/zcml
 
 
-
 Indices and tables
 ==================
 

Modified: zope.security/trunk/src/zope/security/zcml.py
===================================================================
--- zope.security/trunk/src/zope/security/zcml.py	2012-12-23 20:54:11 UTC (rev 128878)
+++ zope.security/trunk/src/zope/security/zcml.py	2012-12-23 20:54:12 UTC (rev 128879)
@@ -25,36 +25,6 @@
 @implementer(IFromUnicode)
 class Permission(zope.schema.Id):
     r"""This field describes a permission.
-
-    Let's look at an example:
-
-    >>> class FauxContext(object):
-    ...     permission_mapping = {'zope.ManageCode':'zope.private'}
-    ...     _actions = []
-    ...     def action(self, **kws):
-    ...        self._actions.append(kws)
-    >>> context = FauxContext()
-    >>> field = Permission().bind(context)
-
-    Let's test the fromUnicode method:
-
-    >>> field.fromUnicode(u'zope.foo')
-    'zope.foo'
-    >>> field.fromUnicode(u'zope.ManageCode')
-    'zope.private'
-
-    Now let's see whether validation works alright
-
-    >>> field._validate('zope.ManageCode')
-    >>> context._actions[0]['args']
-    (None, 'zope.foo')
-    >>> field._validate('3 foo')
-    Traceback (most recent call last):
-    ...
-    InvalidId: 3 foo
-
-    zope.Public is always valid
-    >>> field._validate('zope.Public')
     """
 
     def fromUnicode(self, u):