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.

Files for repoze.sphinx.autointerface, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size repoze.sphinx.autointerface-0.1.tar.gz (8.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page