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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ef0fee8bec34323fd12a07a397b9dbd5a1350cac8686fce5d0fb326308fd64a |
|
MD5 | 5b2df6febf89ce4b86e977aea7f855c6 |
|
BLAKE2b-256 | a1dae14605cc3eeb1f3da427416636931893d317a4606943001d0e86b57e345d |
Hashes for sphinxcontrib_zopeext-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99a1cbec9420e2d97adf7f4c97de6f62b16308629698bb82ff1be175bed629a2 |
|
MD5 | faa78124d8d5332efb55a4eda6e7b8b0 |
|
BLAKE2b-256 | 0c2488524cc344a8f04e50fac78b6885a012d55e656ee2c3fcadabdd5a151989 |