This release is a pre-release and may not be stable for production use.
sphinx-ux-badges
Shared badge node and CSS for Sphinx autodoc extensions in the gp-sphinx ecosystem.
Provides BadgeNode, HTML visitors, and builder helpers shared by
sphinx-autodoc-api-style, sphinx-autodoc-pytest-fixtures,
sphinx-autodoc-sphinx, sphinx-autodoc-docutils, and
sphinx-autodoc-fastmcp.
Install
$ pip install sphinx-ux-badges
Usage
Load the badge layer from your own extension's setup():
def setup(app):
app.setup_extension("sphinx_ux_badges")
Then build badges in your directives or transforms:
from sphinx_ux_badges import build_badge, build_badge_group, build_toolbar
group = build_badge_group(
[
build_badge(
"readonly",
tooltip="Read-only",
classes=["gp-sphinx-fastmcp__safety-readonly"],
),
]
)
Documentation
See the full documentation
for the colour palette reference, BadgeSpec API, and live demos.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-ux-badges 0.1.0a39
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_ux_badges-0.1.0a39.tar.gz | 16.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_ux_badges-0.1.0a39-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.5 kB
Release files / sphinx_ux_badges-0.1.0a39.tar.gz
| Download URL | sphinx_ux_badges-0.1.0a39.tar.gz |
|---|---|
| Size | 16.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed4337e11483a82acbf2e5fd7749a9867afca459901f41a890263eca18fe95e1
|
|
BLAKE2b-256 checksum How to use checksums |
4050bccae9abbb279dcf11632eb36f18e0599e468ca46559062542d817e28325
|
| 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 Sep 6, 2026.
Transparency logRelease files / sphinx_ux_badges-0.1.0a39-py3-none-any.whl
| Download URL | sphinx_ux_badges-0.1.0a39-py3-none-any.whl |
|---|---|
| Size | 17.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
419df406a66c2cc4f756012fdef9580bfd3f01ea91527c056e1567ece774bdd6
|
|
BLAKE2b-256 checksum How to use checksums |
4ca94c290c43d6fd86d7dc312599da45a57dbbf28d7ad3f1db8d9f4d2fa5f5fb
|
| 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 Sep 6, 2026.
Transparency log
