sphinx.builders.latex

package documentation

LaTeX builder.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Module constants sphinx.builders.latex.constants ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module nodes sphinx.builders.latex.nodes ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module theming sphinx.builders.latex.theming ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module transforms sphinx.builders.latex.transforms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module util sphinx.builders.latex.util ~~~~~~~~~~~~~~~~~~~~~~~~~~

From __init__.py:

Class ​La​Te​XBuilder Builds LaTeX output to create PDF.
Constant XINDY​_CYRILLIC​_SCRIPTS Undocumented
Constant XINDY​_LANG​_OPTIONS Undocumented
Variable logger Undocumented
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
XINDY_LANG_OPTIONS: dict[str, str] =

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] =

Undocumented

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

Undocumented

def validate_config_values(app, config):

Undocumented

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

Undocumented

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def install_packages_for_ja(app):
Install packages for Japanese.
Parameters
app:SphinxUndocumented
def default_latex_engine(config):
Better default latex_engine settings for specific languages.
Parameters
config:ConfigUndocumented
Returns
strUndocumented
def default_latex_docclass(config):
Better default latex_docclass settings for specific languages.
Parameters
config:ConfigUndocumented
Returns
Dict[str, str]Undocumented
def default_latex_use_xindy(config):
Better default latex_use_xindy settings for specific engines.
Parameters
config:ConfigUndocumented
Returns
boolUndocumented
def default_latex_documents(config):
Better default latex_documents settings.
Parameters
config:ConfigUndocumented
Returns
List[Tuple[str, str, str, str, str]]Undocumented
def setup(app):

Undocumented

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