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.

Download files

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

Source Distribution

sphinx_ux_badges-0.0.1a36.tar.gz (16.7 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_ux_badges-0.0.1a36-py3-none-any.whl (17.5 kB view details)

Uploaded Jul 26, 2026 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_ux_badges-0.0.1a36.tar.gz
Algorithm	Hash digest
SHA256	`97e88273f89f63edcbe34bebd95df40f725922f0ba624171e917b43748d98928`
MD5	`6109959f055c3906df801b94f5355b7f`
BLAKE2b-256	`8b23997ebf6a948287c3cfadaf9c995daee14ccfff739c03b2687ecca7c04124`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_ux_badges-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_ux_badges-0.0.1a36.tar.gz
- Subject digest: 97e88273f89f63edcbe34bebd95df40f725922f0ba624171e917b43748d98928
- Sigstore transparency entry: 2255932085
- 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