sphinx.builders.html

package documentation

(source)

Several HTML builders.

Module transforms Transforms for HTML builder.

From __init__.py:

Class	`BuildInfo`	buildinfo file manipulator.
Class	`JavaScript`	A metadata of javascript file.
Class	`StandaloneHTMLBuilder`	Builds standalone HTML docs.
Class	`Stylesheet`	A metadata of stylesheet.
Function	`convert_html_css_files`	This converts string styled html_css_files to tuple styled one.
Function	`convert_html_js_files`	This converts string styled html_js_files to tuple styled one.
Function	`convert_locale_to_language_tag`	Convert a locale string to a language tag (ex. en_US -> en-US).
Function	`deprecate_html_4`	Warn on HTML 4.
Function	`get_stable_hash`	Return a stable hash for a Python data structure. We can't just use the md5 of str(obj) since for example dictionary items are enumerated in unpredictable order due to hash randomization in newer Pythons.
Function	`setup`	Undocumented
Function	`setup_css_tag_helper`	Set up css_tag() template helper.
Function	`setup_js_tag_helper`	Set up js_tag() template helper.
Function	`setup_resource_paths`	Set up relative resource paths.
Function	`validate_html_extra_path`	Check html_extra_paths setting.
Function	`validate_html_favicon`	Check html_favicon setting.
Function	`validate_html_logo`	Check html_logo setting.
Function	`validate_html_static_path`	Check html_static_paths setting.
Function	`validate_math_renderer`	Undocumented
Constant	`INVENTORY_FILENAME`	Undocumented
Type Alias	`DOMAIN_INDEX_TYPE`	Undocumented
Variable	`logger`	Undocumented
Variable	`return_codes_re`	Undocumented

INVENTORY_FILENAME: str = (source) ¶

Undocumented

Value

'objects.inv'

logger = (source) ¶

Undocumented

return_codes_re = (source) ¶

Undocumented

DOMAIN_INDEX_TYPE = (source) ¶

Undocumented

Value

Tuple[str, Type[Index], List[Tuple[str, List[IndexEntry]]], bool]

def get_stable_hash(obj): (source) ¶

Return a stable hash for a Python data structure. We can't just use the md5 of str(obj) since for example dictionary items are enumerated in unpredictable order due to hash randomization in newer Pythons.

Parameters
obj:`Any`	Undocumented
Returns
`str`	Undocumented

def convert_locale_to_language_tag(locale): (source) ¶

Convert a locale string to a language tag (ex. en_US -> en-US). refs: BCP 47 (:rfc:`5646`)

Parameters
locale:`str\|None`	Undocumented
Returns
`str\|None`	Undocumented

def convert_html_css_files(app, config): (source) ¶

This converts string styled html_css_files to tuple styled one.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def convert_html_js_files(app, config): (source) ¶

This converts string styled html_js_files to tuple styled one.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def setup_css_tag_helper(app, pagename, templatename, context, doctree): (source) ¶

Set up css_tag() template helper. .. note:: This set up function is added to keep compatibility with webhelper.

Parameters
app:`Sphinx`	Undocumented
pagename:`str`	Undocumented
templatename:`str`	Undocumented
context:`dict`	Undocumented
doctree:`Node`	Undocumented

def setup_js_tag_helper(app, pagename, templatename, context, doctree): (source) ¶

Set up js_tag() template helper. .. note:: This set up function is added to keep compatibility with webhelper.

Parameters
app:`Sphinx`	Undocumented
pagename:`str`	Undocumented
templatename:`str`	Undocumented
context:`dict`	Undocumented
doctree:`Node`	Undocumented

def setup_resource_paths(app, pagename, templatename, context, doctree): (source) ¶

Set up relative resource paths.

Parameters
app:`Sphinx`	Undocumented
pagename:`str`	Undocumented
templatename:`str`	Undocumented
context:`dict`	Undocumented
doctree:`Node`	Undocumented

def validate_math_renderer(app): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented

def validate_html_extra_path(app, config): (source) ¶

Check html_extra_paths setting.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def validate_html_static_path(app, config): (source) ¶

Check html_static_paths setting.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def validate_html_logo(app, config): (source) ¶

Check html_logo setting.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def validate_html_favicon(app, config): (source) ¶

Check html_favicon setting.

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def deprecate_html_4(_app, config): (source) ¶

Warn on HTML 4.

Parameters
_app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def setup(app): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
Returns
`dict[str, Any]`	Undocumented