repoze.sphinx.autointerface README

Overview

Thie package 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