API Reference

Badge reference

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

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

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

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