sphinx-interrogatedb
This is a Sphinx extension that provides autodoc support for modules created by interrogate, by augmenting it with information provided by interrogate databases (.in files).
Usage
To make use of this extension, the following steps are needed:
- Install the module using pip.
pip install sphinx-interrogatedb
- Enable it in
conf.py.
extensions = ['sphinx.ext.autodoc', 'sphinx_interrogatedb']
- Configure the search path for interrogatedb files.
interrogatedb_search_path = ['dir/containing/in/files/']
- Just use autodoc, autosummary or autopackagesummary as you would normally, and the .in files will automatically be processed.
Configuration
The following configuration options are supported:
interrogatedb_search_path: list of folders to search for .in files.autodoc_interrogatedb_mangle_type_names: if True, converts type names in the way that interrogate's python-native back-end does by default.autodoc_interrogatedb_mangle_type_names: if True, converts type names from snake-case to camel-case. False by default.autodoc_interrogatedb_type_annotations: if True, shows argument and return types in function signatures using type hint syntax. True by default.autodoc_interrogatedb_add_rtype: if True, adds an:rtype:directive to the bodies of docstrings with the return type. True by default.
License
This extension has been licensed under the terms of the Modified BSD License.
Metadata
Release files for sphinx-interrogatedb 2.0.2
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 | Actions |
|---|---|---|---|---|
| sphinx_interrogatedb-2.0.2.tar.gz | 11.8 kB | Without provenance | Details for sphinx_interrogatedb-2.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_interrogatedb-2.0.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_interrogatedb-2.0.2-py3-none-any.whl |
Total release size: 23.3 kB
Release files / sphinx_interrogatedb-2.0.2.tar.gz
| Download URL | sphinx_interrogatedb-2.0.2.tar.gz |
|---|---|
| Size | 11.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f86d1a6f181885bc13af5bc2e000658c9a05f48b67c8ec330d94f1647a8fd1b9
|
|
BLAKE2b-256 checksum How to use checksums |
53c740388726fe0ad36c7df1efd09c489a91ef05eb2d0005fa2352b6df646a02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.5
|
Release files / sphinx_interrogatedb-2.0.2-py3-none-any.whl
| Download URL | sphinx_interrogatedb-2.0.2-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07914b886790d1abd8e105dc51466afd578f0f1b006ee3264eb592214ebbeacd
|
|
BLAKE2b-256 checksum How to use checksums |
eba9217da599d02e5be747f9f0d3237bacbd5a73131a8b6cc73867fc928dd908
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.5
|
Security for sphinx-interrogatedb 2.0.2
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.