This release is a pre-release and may not be stable for production use.
sphinx-autodoc-sphinx
Sphinx extension for documenting the objects extensions register with
Sphinx — config values from app.add_config_value(), builders from
app.add_builder(), and domains from app.add_domain() — as copyable
reference entries.
Rendered entries use the shared stack: sphinx_ux_autodoc_layout owns the
visible api-* structure, sphinx_ux_badges owns badge output, and
sphinx_autodoc_typehints_gp is auto-loaded so displayed config types follow the same
annotation rules as the rest of the autodoc family.
Install
$ pip install sphinx-autodoc-sphinx
Usage
extensions = ["sphinx_autodoc_sphinx"]
Then document one config value:
```{eval-rst}
.. autoconfigvalue:: sphinx_fonts.sphinx_font_preload
```
Or generate a full reference section for an extension module:
.. autoconfigvalues:: sphinx_fonts
Builders and domains follow the same single + bulk pattern:
.. autobuilder:: my_project.builders.ZipBuilder
.. autodomains:: my_project
Builder and domain entries register targets in a sphinxext Sphinx
domain, so prose can cross-reference them with roles like
:sphinxext:builder:`ZipBuilder`.
Documentation
See the full documentation
for live demos, generated confval entries, and downstream usage patterns.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-sphinx 0.1.0a38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_autodoc_sphinx-0.1.0a38.tar.gz | 18.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autodoc_sphinx-0.1.0a38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.2 kB
Release files / sphinx_autodoc_sphinx-0.1.0a38.tar.gz
| Download URL | sphinx_autodoc_sphinx-0.1.0a38.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2249b409d2c8aa0dd3ef9cc2029d9a0874923217be04321da7f23a745256b1ed
|
|
BLAKE2b-256 checksum How to use checksums |
9c4e6c113483af4973c2a86df1255deedbe31528286c8f7aa760fb44517205b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 30, 2026.
Transparency logRelease files / sphinx_autodoc_sphinx-0.1.0a38-py3-none-any.whl
| Download URL | sphinx_autodoc_sphinx-0.1.0a38-py3-none-any.whl |
|---|---|
| Size | 22.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb2b28a5903fb1b74a699a4e166d83c197e106b88a3279d100568a6ea4d9c6a3
|
|
BLAKE2b-256 checksum How to use checksums |
0b6ef534165605e42f665b0c31339b778fcca2dfc829b4c7d6f074347ec4c085
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 30, 2026.
Transparency log
