Project Links

Meta

Author: Michael McNeil Forbes

Requires Python: >=3.7

Classifiers

Operating System

OS Independent

Programming Language

Python
Python :: 3
Python :: 3.7
Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12
Python :: 3.13
Python :: 3.14

License

OSI Approved :: BSD License

Development Status

4 - Beta

Framework

Sphinx :: Extension
Zope

Topic

Documentation
Documentation :: Sphinx

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

Wheel compatibility matrix

Platform	Python 3
any

Files in release

sphinxcontrib_zopeext-0.4.4-py3-none-any.whl (7.4KiB)

sphinxcontrib_zopeext-0.4.4.tar.gz (47.6KiB)

Extras:

Dependencies:

zope.interface (>=5.5.2)

Sphinx (>=4.5.0)

sphinxcontrib-zopeext 0.4.4