Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.
Reason this release was yanked:
Does not actually include the source!
Project description
This extension provides an autointerface directive for Zope interfaces.
Requirements
Sphinx: pip install sphinx
zope.interface: pip install zope.interface
sphinxcontrib.zopeext: pip install sphinxcontrib-zopeext
Usage
In the build configuration file (the conf.py in your Sphinx documentation directory) add sphinxcontrib.zopeext.autointerface to your extensions list:
extensions = [..., 'sphinxcontrib.zopeext.autointerface', ...]
Then, in your documentation, use autointerface as you would use autoclass. You can refer to the interface with the :py:interface: role example.IMyInterface as you would use the :py:class: role to refer to the implementation example.MyImplementation:
.. automodule:: example
:show-inheritance:
:inherited-members:
One can also limit which members are displayed, just as you would with .. autoclass:
.. autointerface:: example.IMyInterface
:members: x, equals
.. autoclass:: example.MyImplementation
:members: x, equals
Project details
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
Built Distribution
Hashes for sphinxcontrib_zopeext-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a20c623b9976503d5becb0610cbc9f1c59b8fb0638ea24043037fdee8b801502 |
|
MD5 | e6967b03244d6da55424f013de965b53 |
|
BLAKE2b-256 | 478ebf5fa7aa7a67d5a43cc9004b0e0173efc6378ac7f2346ff967e99f100093 |
Hashes for sphinxcontrib_zopeext-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be8bc6b314d9b66b123d34195fd7eb2b1aa49e14fc572ab1e8b4288dcb67051a |
|
MD5 | ca5e5c23d689ab5ecd5fae4fba457f5a |
|
BLAKE2b-256 | 1ec57b8ceb7f710dc1dbcfffa1e81a4193b3bacb4df4fd914e9b0b0baf7a1aa1 |