Skip to content

Commit

Permalink
Basic automodule directives for the modules in zope.interface.common.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamadden committed Jul 19, 2018
1 parent 39ca0c5 commit 1538324
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1102,3 +1102,31 @@ The component registry's API is defined by
.. autointerface:: zope.interface.interfaces.IComponentRegistry
:members:
:member-order: bysource

Python Standard Library Interfaces
==================================

The ``zope.interface.common`` package provides interfaces for objects
distributed as part of the Python standard library. Importing these
modules has the effect of making the standard library objects
implement the correct interface.

``zope.interface.common.interfaces``
------------------------------------

.. automodule:: zope.interface.common.interfaces

``zope.interface.common.idatetime``
-----------------------------------

.. automodule:: zope.interface.common.idatetime

``zope.interface.common.mapping``
---------------------------------

.. automodule:: zope.interface.common.mapping

``zope.interface.common.sequence``
----------------------------------

.. automodule:: zope.interface.common.sequence
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,3 +261,6 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

autodoc_default_flags = ['members', 'show-inheritance']
autoclass_content = 'both'

0 comments on commit 1538324

Please sign in to comment.