Skip to main content

Sphinx extension: auto-generates API docs from Zope intervces

Project description

repoze.sphinx.autointerface README
==================================

Overview
--------

Thie package defines an extension for the
`Sphinx <http://sphinx.pocool.org>`_ documentation system.

Installation
------------

Install via :command:`easy_install` or any other mechanism to get the
package on the path.

Registering the Extension
-------------------------

Add ``repoze.sphinx.autointerface`` to the ``conf.py`` of the docs
section of your product.

Using the Extension
-------------------

At appropriate points in your document, call out the interface
autodocs via::

.. autoinclude:: yourpackage.interfaces.IFoo
:members:


repoze.sphinx.autointerface Changelog
=====================================

0.1 (2008-10-02)
----------------

- Initial release.

Project details


Download files

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

Source Distribution

repoze.sphinx.autointerface-0.1.tar.gz (8.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page