Skip to main content

Provides sphinxcontrib.zopeext.autointerface for documenting Zope interfaces.

Project description

zopeext for Sphinx

Test badge PyPI badge gh: tag badge Coverage badge Documentation status badge Python versions badge

This extension provides an autointerface directive for Zope interfaces.


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.


In the build configuration file (the 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

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib_zopeext-0.4.3.tar.gz (48.4 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_zopeext-0.4.3-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page