sphinx.builders.html

package documentation

Several HTML builders.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Module transforms sphinx.builders.html.transforms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From __init__.py:

Class	`StandaloneHTMLBuilder`	Builds standalone HTML docs.
Constant	`INVENTORY_FILENAME`	Undocumented
Constant	`UNSET`	Undocumented
Variable	`html5_ready`	Undocumented
Variable	`logger`	Undocumented
Variable	`return_codes_re`	Undocumented
Class	`_stable_repr_object`	Undocumented
Class	`BuildInfo`	buildinfo file manipulator.
Class	`JavaScript`	A metadata of javascript file.
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	`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	`migrate_html_add_permalinks`	Migrate html_add_permalinks to html_permalinks*.
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

html5_ready: bool =

Undocumented

INVENTORY_FILENAME: str =

Undocumented

Value

'objects.inv'

logger =

Undocumented

return_codes_re =

Undocumented

def get_stable_hash(obj):

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_html_css_files(app, config):

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):

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):

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):

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):

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):

Undocumented

Parameters
app:`Sphinx`	Undocumented

def validate_html_extra_path(app, config):

Check html_extra_paths setting.

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

def validate_html_static_path(app, config):

Check html_static_paths setting.

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

def validate_html_logo(app, config):

Check html_logo setting.

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

def validate_html_favicon(app, config):

Check html_favicon setting.

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

UNSET =

Undocumented

Value

_stable_repr_object()

def migrate_html_add_permalinks(app, config):

Migrate html_add_permalinks to html_permalinks*.

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

def setup(app):

Undocumented

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