Metadata-Version: 2.4
Name: sphinx-ux-badges
Version: 0.0.1a13
Summary: Shared badge node and CSS for Sphinx autodoc extensions
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: badges,documentation,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# 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

```console
$ pip install sphinx-ux-badges
```

## Usage

Load the badge layer from your own extension's `setup()`:

```python
def setup(app):
    app.setup_extension("sphinx_ux_badges")
```

Then build badges in your directives or transforms:

```python
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](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/)
for the colour palette reference, `BadgeSpec` API, and live demos.
