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.
==================================
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file repoze.sphinx.autointerface-0.1.tar.gz.
File metadata
- Download URL: repoze.sphinx.autointerface-0.1.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
10196795c2887eee4d25f73d1d3e9480f701afcbdbcd4b65e9dcf00780c44846
|
|
| MD5 |
8bbe1218b934d2a19d723640794d433e
|
|
| BLAKE2b-256 |
f62c797196ea5b564cf58950526ab6fb05dbe9e69f6d26094fe09b5a4e727564
|
