Overview
Thie package defines an extension for the Sphinx documentation system. The extension allows generation of API documentation by introspection of zope.interface instances in code.
Installation
Install via pip:
pip install repoze.sphinx.autointerfaceRegistering the Extension
Add repoze.sphinx.autointerface to the extensions list in the conf.py of the Sphinx documentation for your product.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"repoze.sphinx.autointerface",
]Using the Extension
At appropriate points in your document, call out the autodoc interface.
.. autointerface:: yourpackage.interfaces.IFooOutput from the directive includes
the fully-qualified interface name
any base interfaces
the docstring from the interface, rendered as reStructuredText
the members of the interface (methods and attributes)
For each attribute, the output includes the attribute name and its description.
For each method, the output includes the method name, its signature, and its docstring (also rendered as reStructuredText).
Release files for repoze-sphinx-autointerface 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| repoze_sphinx_autointerface-1.1.0.tar.gz | 10.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| repoze_sphinx_autointerface-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.8 kB
Release files / repoze_sphinx_autointerface-1.1.0.tar.gz
| Download URL | repoze_sphinx_autointerface-1.1.0.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d17ba776019efc9b36415fb3fbb0820f23c3c2e816238c420f1d803f6ad3137
|
|
BLAKE2b-256 checksum How to use checksums |
adb79192240e74b747a08b59a7e54fe88039c15065c5d2571c1ef0a915e5f5e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 4, 2026.
Transparency logRelease files / repoze_sphinx_autointerface-1.1.0-py3-none-any.whl
| Download URL | repoze_sphinx_autointerface-1.1.0-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
932700ff64612b72447a93e958e67c27dd09a881d6dc97d801e98bdfa932c07f
|
|
BLAKE2b-256 checksum How to use checksums |
cdcabf0f1bb5ea32ff0d1031c532b49a4a1c2a0a6152e25ac252210af2d55ec2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 4, 2026.
Transparency log
