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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8206fdad31859f7a73435e66abddac5c8f69224df679dee0bceb95498aa7ac70 |
|
MD5 | a015f6ca9019dbf731d0880994461675 |
|
BLAKE2b-256 | 10a586f2d131abd1ffdeb9d6f8f74c8c7e57d9b3518c713703acc3d455735111 |
Hashes for sphinxcontrib_zopeext-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d9a165afd5f492f110e292700cf614b658092b040d1823dcb6ef00528a2584a |
|
MD5 | 6069a29fdf5034c12c30d1b901ea18f6 |
|
BLAKE2b-256 | 5e3469d7165f1ea5fad067e8d2475a0a9832d33bdd280614b1ca81376bc6b111 |