This release is a pre-release and may not be stable for production use.
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-api-style 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_api_style-0.1.0a38.tar.gz | 9.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autodoc_api_style-0.1.0a38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 19.0 kB
Release files / sphinx_autodoc_api_style-0.1.0a38.tar.gz
| Download URL | sphinx_autodoc_api_style-0.1.0a38.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3a6c801356f49718a23008b4031208a55feac228ea3b038487543bae6df4c55
|
|
BLAKE2b-256 checksum How to use checksums |
c81adf9f6f4ae05ebe7bc46ee60a776a63caebdd2f2e39433dc1e60c3ac1162f
|
| 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_api_style-0.1.0a38-py3-none-any.whl
| Download URL | sphinx_autodoc_api_style-0.1.0a38-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e71d75041b1f5b49c8cd3f8d0d76b49788c2aa8bf1bb0233ad8fd41212791839
|
|
BLAKE2b-256 checksum How to use checksums |
b33b0245d388fde2c91c45eef6c746c39c6799c3726429bdf0efba564d4100f5
|
| 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
