repoze.sphinx.autointerface 0.7.0

Auto-generates API docs from Zope interfaces

  Add it to your Download Basket!

 Add it to your Watch List!

0/5

Rate it!

What's new in repoze.sphinx.autointerface 0.7.0:

  • 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.
Read full changelog
send us
an update
LICENSE TYPE:
BSD License 
USER RATING:
UNRATED
  0.0/5
DEVELOPED BY:
Agendaless Consulting
HOMEPAGE:
www.repoze.org
CATEGORY:
ROOT \ Internet \ HTTP (WWW)
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).

Last updated on June 21st, 2012

requirements

#API docs #Zope interface #API #docs #generator #Zope

Add your review!

SUBMIT