Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx extension: auto-generates API docs from Zope interfaces

Project Description

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

  • the fully-qualified interface name
  • any base interfaces
  • the doctstring from the interface, rendered as reSTX.
  • the members of the interface (methods and attributes).
    • For each attribute, the output includes the attribute name and its description.
    • For each method, the output includes the method name, its signature, and its docstring (also rendered as reSTX).

repoze.sphinx.autointerface Changelog

0.6 (2011-01-28)

  • Correctly handle ‘:members:’ values explicitly set in the directive.

0.5 (2011-01-18)

  • Added support for the ‘:member-order:’ flag, which can take one of the three stock values, “alphabetical”, “groupwise”, or “bysource”. By default, members are documented in “hash” order.

0.4 (2010-07-26)

  • Fixed compatibility with Sphinx 1.0
  • Un-break PyPI ReST/HTML-rendering again.

0.3 (2009-10-25)

  • Refactor sphinx integration. There are now separate autointerface and interface directives.

0.2.1 (2009-08-20)

  • Fix add_directive arguments to work with Sphinx 0.6.1, now required.

0.1.3 (2009-01-14)

  • Coerce unicode path elements to str in _resolve_dotted_name. Note that non-ASCII path elements won’t work: this fix just deals with the case where the path was of type unicode.
  • Fixed spelling of directive in README.txt.
  • Added dependency on zope.interface.

0.1.2 (2008-10-03)

  • Packaging change: improved description in README.txt.

0.1.1 (2008-10-03)

  • Packaging bug: the long_description was not rendering properly to HTML on PyPI.

0.1 (2008-10-02)

  • Initial release.
Release History

Release History

History Node

0.8

History Node

0.7.1

History Node

0.7.0

History Node

0.6.2

History Node

0.6.1

This version
History Node

0.6

History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2.1

History Node

0.2

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
repoze.sphinx.autointerface-0.6.tar.gz (9.0 kB) Copy SHA256 Checksum SHA256 Source Jan 28, 2011

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting