repoze.sphinx.autointerface Auto-generates API docs from Zope interfaces
Download

repoze.sphinx.autointerface Ranking & Summary

repoze.sphinx.autointerface Tags

api generator Docs API docs

repoze.sphinx.autointerface Description

Auto-generates API docs from Zope interfaces 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.autointerfaceor any other means which gets the package on your PYTHONPATH.Registering the ExtensionAdd repoze.sphinx.autointerface to the extensions list in the conf.py of the Sphinx documentation for your product. E.g.:extensions = Using the ExtensionAt appropriate points in your document, call out the interface autodocs via:.. autointerface:: yourpackage.interfaces.IFooOutput 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). Requirements: · Python · Sphinx What's New in This Release: · Fix TypeError: 'NoneType' object is not iterable error when generating a rendering of an interface under Python 2.7.

repoze.sphinx.autointerface Related Software