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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a6b8ab25c04af01c7a5aaf72600ebc4bb3595dd56997f51da46e4acdffb8807 |
|
MD5 | 12f1489ec1f278e04875df1e1af58a90 |
|
BLAKE2b-256 | ac57be167aa7e11754ffdee6f456c9817b01a8c60f76e560d1d93bdf242103e3 |
Hashes for sphinxcontrib_zopeext-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db41ed7c10d2af796c1b91d73754e336f20ff1cc013d231ed98b3ee6c831dfcb |
|
MD5 | de0068e51ee2e65147266b5d81b2fe77 |
|
BLAKE2b-256 | 4884f2cab2e99903d693916cd69fb958facd9f921eca9961f2bc76d461d6363b |