Metadata-Version: 1.0
Name: repoze.sphinx.autointerface
Version: 0.1
Summary: Sphinx extension: auto-generates API docs from Zope intervces
Home-page: http://www.repoze.org
Author: Agendaless Consulting
Author-email: repoze-dev@lists.repoze.org
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
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.
        
Keywords: web wsgi zope
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
