j1m.sphinxautointerface 0.3.0

Sphinx extension for documenting zope.interface interfaces

This package contains a fork of the zopeext Sphinx extension.

Original documentation: http://packages.python.org/sphinxcontrib-zopeext

Install with pip install j1m.sphinxautointerface.

To use this extension, include ‘j1m.sphinxautointerface’ in your extensions list in the conf.py file for your documentation.

This provides some support for Zope interfaces by providing an autointerface directive that acts like autoclass except uses the Zope interface methods for attribute and method lookup (the interface mechanism hides the attributes and method so the usual autoclass directive fails.) Interfaces are intended to be very different beasts than regular python classes, and as a result require customized access to documentation, signatures etc.

See Also

• http://sphinx.pocoo.org/

• http://sphinx.pocoo.org/ext/autodoc.html

• http://docs.zope.org/zope.interface/README.html

• http://packages.python.org/sphinxcontrib-zopeext/