repoze.sphinx.autointerface defines an extension for the Sphinx documentation system. The extension allows generation of API documentation by introspection of zope.interface instances in code.
Installation:
Install via easy_install:
bin/easy_install repoze.sphinx.autointerface
or any other means which gets the package on your PYTHONPATH.
Registering the Extension
Add repoze.sphinx.autointerface to the extensions list in the conf.py of the Sphinx documentation for your product. E.g.:
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'repoze.sphinx.autointerface',
]
Using the Extension
At appropriate points in your document, call out the interface autodocs via:
.. autointerface:: yourpackage.interfaces.IFoo
Output from the directive includes
* the fully-qualified interface name
* any base interfaces
* the doctstring from the interface, rendered as reSTX.
* the members of the interface (methods and attributes).
o For each attribute, the output includes the attribute name and its description.
o For each method, the output includes the method name, its signature, and its docstring (also rendered as reSTX).
What is new in this release:
- PyPy compatibility.
- Python 3.2+ compatibility. Thanks to Arfrever for the patch.
- Include interface docs under the automodule directive. Thanks to Krys Lawrence for the patch.
What is new in version 0.6.2:
- Fix TypeError: 'NoneType' object is not iterable error when generating a rendering of an interface under Python 2.7.
What is new in version 0.6.1:
- Fix ':member-order: bysource' handling.
What is new in version 0.6:
- Correctly handle ':members:' values explicitly set in the directive.
What is new in version 0.5:
- Added support for the ':member-order:' flag, which can take one of the three stock values, "alphabetical", "groupwise", or "bysource". By default, members are documented in "hash" order.
Requirements:
- Python
- Sphinx
Comments not found