From 34ffae2afa52de6d96ffdfda6409a654f37720e7 Mon Sep 17 00:00:00 2001 From: Jason Madden Date: Thu, 14 Sep 2017 10:11:02 -0500 Subject: cross-refs and cleanups for checker and adapter. --- docs/api/adapter.rst | 7 ++--- docs/api/checker.rst | 68 ++++++++++++++++++++++++++-------------------- docs/api/interfaces.rst | 6 ++-- docs/api/metaconfigure.rst | 5 ++++ docs/conf.py | 1 + docs/index.rst | 16 ++++++----- 6 files changed, 60 insertions(+), 43 deletions(-) create mode 100644 docs/api/metaconfigure.rst (limited to 'docs') diff --git a/docs/api/adapter.rst b/docs/api/adapter.rst index bf651f2..d290b47 100644 --- a/docs/api/adapter.rst +++ b/docs/api/adapter.rst @@ -1,6 +1,5 @@ -:mod:`zope.security.adapter` -============================ +======================= + zope.security.adapter +======================= .. automodule:: zope.security.adapter - :members: - :member-order: bysource diff --git a/docs/api/checker.rst b/docs/api/checker.rst index 419fe5e..7c62d5c 100644 --- a/docs/api/checker.rst +++ b/docs/api/checker.rst @@ -1,17 +1,25 @@ -:mod:`zope.security.checker` -============================ +======================= + zope.security.checker +======================= + +.. currentmodule:: zope.security.checker + + +Module API Documentation +======================== .. automodule:: zope.security.checker - :members: - :member-order: bysource +API Doctests +============ + Protections for Modules ----------------------- -The :func:`zope.secuirty.checker.moduleChecker` API can be used to -determine whether a module has been protected: Initially, there's no checker -defined for the module: +The :func:`moduleChecker` API can be used to determine whether a +module has been protected: Initially, there's no checker defined for +the module: .. doctest:: @@ -20,7 +28,9 @@ defined for the module: >>> moduleChecker(test_zcml_functest) is None True -We can add a checker using :func:`zope.security.metaconfigure.protectModule`: +We can add a checker using +:func:`zope.security.metaconfigure.protectModule` (although this is +more commonly done using ZCML): .. doctest:: @@ -202,26 +212,26 @@ Protections for standard objects ... return 'ForbiddenAttribute: %s' % e.args[0] Rocks -##### +~~~~~ -Rocks are immuatle, non-callable objects without interesting methods. They +Rocks are immutable, non-callable objects without interesting methods. They *don't* get proxied. .. doctest:: - >>> type(ProxyFactory( object() )) is object + >>> type(ProxyFactory(object())) is object True - >>> type(ProxyFactory( 1 )) is int + >>> type(ProxyFactory(1)) is int True - >>> type(ProxyFactory( 1.0 )) is float + >>> type(ProxyFactory(1.0)) is float True - >>> type(ProxyFactory( 1j )) is complex + >>> type(ProxyFactory(1j)) is complex True - >>> type(ProxyFactory( None )) is type(None) + >>> type(ProxyFactory(None)) is type(None) True - >>> type(ProxyFactory( 'xxx' )) is str + >>> type(ProxyFactory('xxx')) is str True - >>> type(ProxyFactory( True )) is type(True) + >>> type(ProxyFactory(True)) is type(True) True Datetime-reltatd instances are rocks, too: @@ -249,7 +259,7 @@ Datetime-reltatd instances are rocks, too: dicts -##### +~~~~~ We can do everything we expect to be able to do with proxied dicts. @@ -301,7 +311,7 @@ not checking that under python > 2): True lists -##### +~~~~~ We can do everything we expect to be able to do with proxied lists. @@ -357,7 +367,7 @@ Always available: True tuples -###### +~~~~~~ We can do everything we expect to be able to do with proxied tuples. @@ -404,7 +414,7 @@ Always available: True sets -#### +~~~~ we can do everything we expect to be able to do with proxied sets. @@ -576,7 +586,7 @@ with any kind of proxy. frozensets -########## +~~~~~~~~~~ we can do everything we expect to be able to do with proxied frozensets. @@ -754,7 +764,7 @@ with any kind of proxy. True iterators -######### +~~~~~~~~~ .. doctest:: @@ -823,7 +833,7 @@ We shouldn't be able to iterate if we don't have an assertion: New-style classes -################# +~~~~~~~~~~~~~~~~~ .. doctest:: @@ -859,7 +869,7 @@ Always available: True New-style Instances -################### +~~~~~~~~~~~~~~~~~~~ .. doctest:: @@ -891,7 +901,7 @@ Always available: Classic Classes -############### +~~~~~~~~~~~~~~~ .. doctest:: @@ -925,7 +935,7 @@ Always available: True Classic Instances -################# +~~~~~~~~~~~~~~~~~ .. doctest:: @@ -955,7 +965,7 @@ Always available: True Interfaces and declarations -########################### +~~~~~~~~~~~~~~~~~~~~~~~~~~~ We can still use interfaces though proxies: @@ -989,7 +999,7 @@ We can still use interfaces though proxies: abstract Base Classes -##################### +~~~~~~~~~~~~~~~~~~~~~ We work with the ABCMeta meta class: diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst index 58d7756..5a3bc01 100644 --- a/docs/api/interfaces.rst +++ b/docs/api/interfaces.rst @@ -1,5 +1,5 @@ -================================= - :mod:`zope.security.interfaces` -================================= +========================== + zope.security.interfaces +========================== .. automodule:: zope.security.interfaces diff --git a/docs/api/metaconfigure.rst b/docs/api/metaconfigure.rst new file mode 100644 index 0000000..a4459b8 --- /dev/null +++ b/docs/api/metaconfigure.rst @@ -0,0 +1,5 @@ +============================= + zope.security.metaconfigure +============================= + +.. automodule:: zope.security.metaconfigure diff --git a/docs/conf.py b/docs/conf.py index caabf00..31497bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -263,6 +263,7 @@ intersphinx_mapping = { 'https://zopeinterface.readthedocs.io/en/latest': None, 'https://zopeproxy.readthedocs.io/en/latest': None, 'https://zopeschema.readthedocs.io/en/latest': None, + 'https://zopelocation.readthedocs.io/en/latest': None, } extlinks = {'issue': ('https://github.com/zopefoundation/zope.datetime/issues/%s', diff --git a/docs/index.rst b/docs/index.rst index f6418b6..ccd5b84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,9 @@ -:mod:`zope.security` Documentation -================================== +==================================== + ``zope.security`` Documentation +==================================== Narrative Documentation ------------------------ +======================= .. toctree:: :maxdepth: 2 @@ -11,7 +12,7 @@ Narrative Documentation hacking API Reference -------------- +============= .. toctree:: :maxdepth: 2 @@ -26,13 +27,14 @@ API Reference api/proxy api/simplepolicies api/testing + api/metaconfigure api/zcml -Indices and tables -================== +==================== + Indices and tables +==================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -- cgit v1.2.1