sphinx-autodoc-api-style 0.0.1a16.dev2

Sphinx extension for enhanced autodoc API entry styling (badges and cards)

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.