Sphinx extension for enhanced autodoc API entry styling (badges and cards)
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
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.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_autodoc_api_style-0.0.1a25.tar.gz.
File metadata
- Download URL: sphinx_autodoc_api_style-0.0.1a25.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30f62c935472dfec15a2ffef1168faaaaf921be015bf2a5ab6130ae0a570ba48
|
|
| MD5 |
ff9e30ea7e37a50d8881db0f3ce09533
|
|
| BLAKE2b-256 |
7485be3ee049538ca377519276d118ff21d5322da0d6210427d86f7a634534f5
|
Provenance
The following attestation bundles were made for sphinx_autodoc_api_style-0.0.1a25.tar.gz:
Publisher:
release.yml on git-pull/gp-sphinx
-
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.0.1a25.tar.gz -
Subject digest:
30f62c935472dfec15a2ffef1168faaaaf921be015bf2a5ab6130ae0a570ba48 - Sigstore transparency entry: 1629569351
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@3beaa63ac4a1c5f9283756ea4026c14f406fc30f -
Branch / Tag:
refs/tags/v0.0.1a25 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3beaa63ac4a1c5f9283756ea4026c14f406fc30f -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_autodoc_api_style-0.0.1a25-py3-none-any.whl.
File metadata
- Download URL: sphinx_autodoc_api_style-0.0.1a25-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25a69b0ae8d3944b1d0c6f7492f415094b6cb0c195ea8a0fb87262fb9e8d3fef
|
|
| MD5 |
de931d473aaeeff2b6dc513f69291855
|
|
| BLAKE2b-256 |
405cd9b7b05c3ad9a31394f09786b528600ed207ea74e4eb3d72255f517ead37
|
Provenance
The following attestation bundles were made for sphinx_autodoc_api_style-0.0.1a25-py3-none-any.whl:
Publisher:
release.yml on git-pull/gp-sphinx
-
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.0.1a25-py3-none-any.whl -
Subject digest:
25a69b0ae8d3944b1d0c6f7492f415094b6cb0c195ea8a0fb87262fb9e8d3fef - Sigstore transparency entry: 1629569771
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@3beaa63ac4a1c5f9283756ea4026c14f406fc30f -
Branch / Tag:
refs/tags/v0.0.1a25 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3beaa63ac4a1c5f9283756ea4026c14f406fc30f -
Trigger Event:
push
-
Statement type:
