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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-zopeext 0.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinxcontrib_zopeext-0.4.4.tar.gz | 48.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_zopeext-0.4.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 56.3 kB
Release files / sphinxcontrib_zopeext-0.4.4.tar.gz
| Download URL | sphinxcontrib_zopeext-0.4.4.tar.gz |
|---|---|
| Size | 48.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c4a354a4bc98972fad53395d62d2bad62db875988cd15d9b307b8be114e4d56a
|
|
BLAKE2b-256 checksum How to use checksums |
99d5ce0d62a7feed5d1d8df253895265e334854df7c9fa9fb9b7dc7a631ba754
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.26.2 CPython/3.11.13 Darwin/23.6.0
|
Release files / sphinxcontrib_zopeext-0.4.4-py3-none-any.whl
| Download URL | sphinxcontrib_zopeext-0.4.4-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9aebc834be6fc94fd60dacec160921484291d3932122b1c795df8fe59ef5961
|
|
BLAKE2b-256 checksum How to use checksums |
2fc72119272fe5d84ad0f9eca5537c1fd5784cc55e60b25ebf374003d7e6f7a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.26.2 CPython/3.11.13 Darwin/23.6.0
|
Security for sphinxcontrib-zopeext 0.4.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
