sphinx.builders.latex

package documentation
(source)

LaTeX builder.

Module constants consntants for LaTeX builder.
Module nodes Additional nodes for LaTeX writer.
Module theming Theming support for LaTeX builder.
Module transforms Transforms for LaTeX builder.
Module util Utilities for LaTeX builder.

From __init__.py:

Class LaTeXBuilder Builds LaTeX output to create PDF.
Function default_latex_docclass Better default latex_docclass settings for specific languages.
Function default_latex_documents Better default latex_documents settings.
Function default_latex_engine Better default latex_engine settings for specific languages.
Function default_latex_use_xindy Better default latex_use_xindy settings for specific engines.
Function install_packages_for_ja Install packages for Japanese.
Function setup Undocumented
Function validate_config_values Undocumented
Function validate_latex_theme_options Undocumented
Constant XINDY_CYRILLIC_SCRIPTS Undocumented
Constant XINDY_LANG_OPTIONS Undocumented
Variable logger Undocumented
XINDY_LANG_OPTIONS: dict[str, str] = (source)

Undocumented

Value
{'sq': '-L albanian -C utf8 ',
 'hr': '-L croatian -C utf8 ',
 'cs': '-L czech -C utf8 ',
 'da': '-L danish -C utf8 ',
 'nl': '-L dutch-ij-as-ij -C utf8 ',
 'en': '-L english -C utf8 ',
 'eo': '-L esperanto -C utf8 ',
...
XINDY_CYRILLIC_SCRIPTS: list[str] = (source)

Undocumented

Value
['be', 'bg', 'mk', 'mn', 'ru', 'sr', 'sh', 'uk']
logger = (source)

Undocumented

def validate_config_values(app, config): (source)

Undocumented

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def validate_latex_theme_options(app, config): (source)

Undocumented

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def install_packages_for_ja(app): (source)

Install packages for Japanese.

Parameters
app:SphinxUndocumented
def default_latex_engine(config): (source)

Better default latex_engine settings for specific languages.

Parameters
config:ConfigUndocumented
Returns
strUndocumented
def default_latex_docclass(config): (source)

Better default latex_docclass settings for specific languages.

Parameters
config:ConfigUndocumented
Returns
dict[str, str]Undocumented
def default_latex_use_xindy(config): (source)

Better default latex_use_xindy settings for specific engines.

Parameters
config:ConfigUndocumented
Returns
boolUndocumented
def default_latex_documents(config): (source)

Better default latex_documents settings.

Parameters
config:ConfigUndocumented
Returns
list[tuple[str, str, str, str, str]]Undocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented