API Reference

Badge reference

All badge classes are drawn from the shared SAB palette. This extension uses:

Object type	SAB constant	CSS class
function	TYPE_FUNCTION	gp-sphinx-badge--type-function
class	TYPE_CLASS	gp-sphinx-badge--type-class
method	TYPE_METHOD	gp-sphinx-badge--type-method
property	TYPE_PROPERTY	gp-sphinx-badge--type-property
attribute	TYPE_ATTRIBUTE	gp-sphinx-badge--type-attribute
data	TYPE_DATA	gp-sphinx-badge--type-data
exception	TYPE_EXCEPTION	gp-sphinx-badge--type-exception

Modifier	SAB constant	CSS class
async	MOD_ASYNC	gp-sphinx-badge--mod-async
classmethod	MOD_CLASSMETHOD	gp-sphinx-badge--mod-classmethod
staticmethod	MOD_STATICMETHOD	gp-sphinx-badge--mod-staticmethod
abstract	MOD_ABSTRACT	gp-sphinx-badge--mod-abstract
final	MOD_FINAL	gp-sphinx-badge--mod-final
deprecated	STATE_DEPRECATED	gp-sphinx-badge--state-deprecated

See sphinx-ux-badges for the full shared palette.

Extension entry point

sphinx_autodoc_api_style.setup(app)

function

function

sphinx_autodoc_api_style.setup(app)

Register the sphinx_autodoc_api_style extension.

Parameters:

app (Sphinx) – The Sphinx application instance.

Returns:

Extension metadata dict.

Return type:

_SetupDict

Examples

>>> callable(setup)
True