Metadata-Version: 2.4
Name: sphinx-autodoc-api-style
Version: 0.0.1a23
Summary: Sphinx extension for enhanced autodoc API entry styling (badges and cards)
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: api,autodoc,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-ux-autodoc-layout==0.0.1a23
Requires-Dist: sphinx-ux-badges==0.0.1a23
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# 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

```console
$ pip install sphinx-autodoc-api-style
```

Installing this package also installs `sphinx-ux-badges` and
`sphinx-ux-autodoc-layout` as declared dependencies.

## Usage

```python
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](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/) for
demos and the badge reference.
