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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_sphinx-0.0.1a36.tar.gz (18.6 kB view details)

Uploaded Jul 26, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_autodoc_sphinx-0.0.1a36-py3-none-any.whl (22.7 kB view details)

Uploaded Jul 26, 2026 Python 3

File details

Details for the file sphinx_autodoc_sphinx-0.0.1a36.tar.gz.

File metadata

Download URL: sphinx_autodoc_sphinx-0.0.1a36.tar.gz
Upload date: Jul 26, 2026
Size: 18.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_autodoc_sphinx-0.0.1a36.tar.gz
Algorithm	Hash digest
SHA256	`ef949260ceeb2fd22f4a7624978cacc3403e5af4f8d3ebd3dc657669fb6429ef`
MD5	`10c20ec6312d7c9f5a6bd219aab82f79`
BLAKE2b-256	`f98449e951601786efb2a0e94ca4f0df538098cdf5e9c5bd8d585f3b247e72d9`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_sphinx-0.0.1a36.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_autodoc_sphinx-0.0.1a36.tar.gz
- Subject digest: ef949260ceeb2fd22f4a7624978cacc3403e5af4f8d3ebd3dc657669fb6429ef
- Sigstore transparency entry: 2255932097
- Sigstore integration time: Jul 26, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Branch / Tag: refs/tags/v0.0.1a36
- Owner: https://github.com/git-pull
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Trigger Event: push