Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.
This extension provides an autointerface directive for Zope interfaces.
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
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for sphinxcontrib-zopeext-0.3.3.tar.gz
Hashes for sphinxcontrib_zopeext-0.3.3-py3-none-any.whl