Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.
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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f059b16dc07402a7457bf4ee696ee676ae1c5fecd2eaf80b6c4d7eac59150e40 |
|
MD5 | 7c6ab820cae147e08570f296690fecbc |
|
BLAKE2b-256 | 5fa4d0da5981f23c3aab3d080cee1faf1ca711df2ef319c5109b9e0341e81535 |
Hashes for sphinxcontrib_zopeext-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ec7da2e8d6173f50fddf165ea4eaa871079053802f1c79621da766725ac43f0 |
|
MD5 | 51f057b36893c30f78131f2e0370c871 |
|
BLAKE2b-256 | b992f47405965ab942a95e36e49d7496611b186a24e790f0b3d351807a080d0e |