Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.
Project description
zopeext for Sphinx
This extension provides an autointerface
directive for Zope interfaces.
Installation
python3 -m pip install sphinxcontrib-zopeext
python3 -m pip install sphinxcontrib-zopeext[test,doc]
This requires Sphinx and zope.interface. The second form includes the test
and doc
extras needed to run the tests and/or build the documentation.
Usage
In the build configuration file (the conf.py
in your Sphinx
documentation directory) add sphinxcontrib.zopeext.autointerface
to your
extensions
list:
# conf.py
...
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40dabeb77ea0eebd8826182ddf4ef0991a9918e519def5ab2c6e429d19f229fd |
|
MD5 | 1c7c99243a878cb4ac19871f2f7e527a |
|
BLAKE2b-256 | 0e38e029b7b2a55d14dcf7cc58b15c7287497e5eec5dfb590d66589e6e33f027 |
Hashes for sphinxcontrib_zopeext-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2dc556263b134d22f14558d7fdaea3bdba9b51f42657a930f9bcc00d438518ea |
|
MD5 | bd5540085173a7687bf7512725097c95 |
|
BLAKE2b-256 | 49fa37aa90181a839e8868b513318eb3625290a587eb61e481f8bf12160be0e7 |