sphinx-autodoc-api-style

Sphinx extension that adds type and modifier badges and card-style containers to standard Python domain autodoc entries (functions, classes, methods, properties, attributes, data, exceptions).

Internally it is now a thin metadata producer on top of the shared stack: sphinx_ux_badges owns badge rendering and sphinx_ux_autodoc_layout owns the api-* entry structure and type rendering.

Install

$ pip install sphinx-autodoc-api-style

Installing this package also installs sphinx-ux-badges and sphinx-ux-autodoc-layout as declared dependencies.

Usage

extensions = ["sphinx_autodoc_api_style"]

No special directives are required — existing .. autofunction::, .. autoclass::, and related directives receive badges automatically.

sphinx_autodoc_api_style automatically registers sphinx_ux_badges and sphinx_ux_autodoc_layout via app.setup_extension(). You do not need to add them separately to your extensions list.

Documentation

See the full documentation for demos and the badge reference.

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_api_style-0.1.0a37.tar.gz (9.5 kB view details)

Uploaded Jul 27, 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_api_style-0.1.0a37-py3-none-any.whl (9.6 kB view details)

Uploaded Jul 27, 2026 Python 3

File details

Details for the file sphinx_autodoc_api_style-0.1.0a37.tar.gz.

File metadata

Download URL: sphinx_autodoc_api_style-0.1.0a37.tar.gz
Upload date: Jul 27, 2026
Size: 9.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_autodoc_api_style-0.1.0a37.tar.gz
Algorithm	Hash digest
SHA256	`e7cec5b2c95a514536f5c30be1e2df4351ae4d9344cab33709cb08b724826e52`
MD5	`37070f3352f7869756bca5e49481714f`
BLAKE2b-256	`8fcdc6180e600d4d7acc9d786eaa34f6b8f853f7f5246d261cf9db5ffdd2548c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_api_style-0.1.0a37.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_api_style-0.1.0a37.tar.gz
- Subject digest: e7cec5b2c95a514536f5c30be1e2df4351ae4d9344cab33709cb08b724826e52
- Sigstore transparency entry: 2256729577
- Sigstore integration time: Jul 27, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Branch / Tag: refs/tags/v0.1.0a37
- 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@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Trigger Event: push