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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0160910ee348221c8338614b8e8297f7bbcf7e022f83ef2412c8533ecb90b56b |
|
MD5 | 7d5023cd336461205dec942996d1617a |
|
BLAKE2b-256 | 2c1a24b23be6763901e4a8e392e06adf6197ab70bdcf148f3e42987caa25e116 |
Hashes for sphinxcontrib_zopeext-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 923d3ca1f350ca88d4a1b1f3fbcada46ca82f537c95916b1dd7057feaf21140f |
|
MD5 | 1f5ca8e2fb4c1d92d6d830a9b45528f3 |
|
BLAKE2b-256 | ac1975037ea01ab03c169b5b0f23a22aa95eb31a54da02e2e60cf2115e4c6eb9 |