Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.
Reason this release was yanked:
Incorrect egg info.
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0112f369855add1f13cddacf895f520810fd0ac277abc27aaeb2180e1c8493e |
|
MD5 | 9ce55ffaa6321f55ba6976b263fa9f4d |
|
BLAKE2b-256 | 388d73537ccf325efebe3326f24ba7b107e63381e0f7dd20e74559ac2b5b6c16 |
Hashes for sphinxcontrib_zopeext-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 640d49c9b101af95e26c9309d59198189dae9d086118e665ad99819cd5711c6c |
|
MD5 | 0bbe938727c1ac1b6da0d6142d60927e |
|
BLAKE2b-256 | d77ba439d00e47ad96ba74ffd5a40e8f64b17b3c2e091d00b4fe24f677dee9d0 |