API Reference

Configuration values

sphinx_fonts
config html
config html
sphinx_fonts

Font family dicts (family, package, version, weights, styles).

Type:

list

Default:

[]

Registered by:

sphinx_fonts.setup()

sphinx_font_fallbacks
config html
config html
sphinx_font_fallbacks

Fallback @font-face declarations with metric overrides for CLS.

Type:

list

Default:

[]

Registered by:

sphinx_fonts.setup()

sphinx_font_css_variables
config html
config html
sphinx_font_css_variables

CSS custom properties for Furo font stacks (e.g. –font-stack)

Type:

dict

Default:

{}

Registered by:

sphinx_fonts.setup()

sphinx_font_preload
config html
config html
sphinx_font_preload

Critical font variants to preload (family, weight, style).

Type:

list

Default:

[]

Registered by:

sphinx_fonts.setup()

Extension entry point

sphinx_fonts.setup(app)
function[source]
function[source]
sphinx_fonts.setup(app)

Register config values, events, and return extension metadata.

Parameters:

app (Sphinx) – The Sphinx application object.

Returns:

Extension metadata.

Return type:

SetupDict