Requirements

• Sphinx: pip install sphinx
• zope.interface: pip install zope.interface
• sphinxcontrib.zopeext: pip install sphinxcontrib-zopeext

Usage

In the build configuration file (the conf.py in your Sphinx documentation directory) add :mod:`sphinxcontrib.zopeext.autointerface` to your extensions list:

extensions = [..., 'sphinxcontrib.zopeext.autointerface', ...]

Then, in your documentation, use :rst:dir:`autointerface` as you would use :rst:dir:`autoclass`. Here is an example (click on the "[source]" link at the right to see the code):

.. autointerface:: sphinxcontrib.zopeext.example.IMyInterface

dl.interface > dt { background-color: #33FF33; }