sphinx.builders.latex.LaTeXBuilder

class documentation

class LaTeXBuilder(Builder): (source)

View In Hierarchy

Builds LaTeX output to create PDF.

Method assemble_doctree Undocumented
Method copy_image_files Undocumented
Method copy_latex_additional_files Undocumented
Method copy_support_files copy TeX support files from texinputs.
Method finish Finish the building process.
Method get_contentsname Undocumented
Method get_outdated_docs Return an iterable of output files that are outdated, or a string describing what an update build will build.
Method get_relative_uri Return a relative URI between two source filenames.
Method get_target_uri Return the target URI for a document name.
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method init_babel Undocumented
Method init_context Undocumented
Method init_document_data Undocumented
Method init_multilingual Undocumented
Method update_context Update template variables for .tex file just before writing.
Method update_doc_context Undocumented
Method write Undocumented
Method write_message_catalog Undocumented
Method write_stylesheet Undocumented
Class Variable epilog Undocumented
Class Variable format Undocumented
Class Variable name Undocumented
Class Variable supported_image_types Undocumented
Class Variable supported_remote_images Undocumented
Instance Variable babel Undocumented
Instance Variable context Undocumented
Instance Variable docnames Undocumented
Instance Variable document_data Undocumented
Instance Variable themes Undocumented
Instance Variable titles Undocumented

Inherited from Builder:

Method __init__ Undocumented
Method build Main build method.
Method build_all Build all source files.
Method build_specific Only rebuild as much as needed for changes in the *filenames*.
Method build_update Only rebuild what was changed or added since last build.
Method cleanup Cleanup any resources.
Method compile_all_catalogs Undocumented
Method compile_catalogs Undocumented
Method compile_specific_catalogs Undocumented
Method compile_update_catalogs Undocumented
Method create_template_bridge Return the template bridge configured.
Method create_translator Return an instance of translator.
Method get_asset_paths Return list of paths for assets (ex. templates, CSS, etc.).
Method get_builder_config Return a builder specific option.
Method get_translator_class Return a class of translator.
Method post_process_images Pick the best candidate for all image URIs.
Method prepare_writing A place where you can add logic before :meth:`write_doc` is run
Method read (Re-)read all files new or changed since last update.
Method read_doc Parse a file and add/update inventory entries for the doctree.
Method set_environment Store BuildEnvironment object.
Method write_doc Where you actually write something to the filesystem.
Method write_doc_serialized Handle parts of write_doc that must be called in the main process if parallel build is active.
Method write_doctree Write the doctree to a file.
Class Variable allow_parallel Undocumented
Class Variable default_translator_class Undocumented
Class Variable supported_data_uri_images Undocumented
Class Variable use_message_catalog Undocumented
Class Variable versioning_compare Undocumented
Class Variable versioning_method Undocumented
Instance Variable app Undocumented
Instance Variable confdir Undocumented
Instance Variable config Undocumented
Instance Variable doctreedir Undocumented
Instance Variable env Undocumented
Instance Variable events Undocumented
Instance Variable finish_tasks Undocumented
Instance Variable imagedir Undocumented
Instance Variable images Undocumented
Instance Variable imgpath Undocumented
Instance Variable outdir Undocumented
Instance Variable parallel_ok Undocumented
Instance Variable srcdir Undocumented
Instance Variable tags Undocumented
Instance Variable templates Undocumented
Method _read_parallel Undocumented
Method _read_serial Undocumented
Method _write_parallel Undocumented
Method _write_serial Undocumented
def assemble_doctree(self, indexfile, toctree_only, appendices): (source)

Undocumented

Parameters
indexfile:strUndocumented
toctree_only:boolUndocumented
appendices:list[str]Undocumented
Returns
nodes.documentUndocumented
def copy_image_files(self): (source)

Undocumented

@progress_message(__('copying additional files'))
def copy_latex_additional_files(self): (source)

Undocumented

@progress_message(__('copying TeX support files'))
def copy_support_files(self): (source)

copy TeX support files from texinputs.

def finish(self): (source)
overrides sphinx.builders.Builder.finish

Finish the building process. The default implementation does nothing.

def get_contentsname(self, indexfile): (source)

Undocumented

Parameters
indexfile:strUndocumented
Returns
strUndocumented
def get_outdated_docs(self): (source)
overrides sphinx.builders.Builder.get_outdated_docs

Return an iterable of output files that are outdated, or a string describing what an update build will build. If the builder does not output individual files corresponding to source files, return a string here. If it does, return an iterable of those files that need to be written.

Returns
str|list[str]Undocumented
def get_relative_uri(self, from_, to, typ=None): (source)
overrides sphinx.builders.Builder.get_relative_uri

Return a relative URI between two source filenames. May raise environment.NoUri if there's no way to return a sensible URI.

Parameters
from_:strUndocumented
to:strUndocumented
typ:str|NoneUndocumented
Returns
strUndocumented
def get_target_uri(self, docname, typ=None): (source)
overrides sphinx.builders.Builder.get_target_uri

Return the target URI for a document name. *typ* can be used to qualify the link characteristic for individual builders.

Parameters
docname:strUndocumented
typ:str|NoneUndocumented
Returns
strUndocumented
def init(self): (source)
overrides sphinx.builders.Builder.init

Load necessary templates and perform initialization. The default implementation does nothing.

def init_babel(self): (source)

Undocumented

def init_context(self): (source)

Undocumented

def init_document_data(self): (source)

Undocumented

def init_multilingual(self): (source)

Undocumented

def update_context(self): (source)

Update template variables for .tex file just before writing.

def update_doc_context(self, title, author, theme): (source)

Undocumented

Parameters
title:strUndocumented
author:strUndocumented
theme:ThemeUndocumented
def write(self, *ignored): (source)
overrides sphinx.builders.Builder.write

Undocumented

Parameters
*ignored:AnyUndocumented
def write_message_catalog(self): (source)

Undocumented

def write_stylesheet(self): (source)

Undocumented

epilog = (source)
overrides sphinx.builders.Builder.epilog

Undocumented

format: str = (source)
overrides sphinx.builders.Builder.format

Undocumented

name: str = (source)
overrides sphinx.builders.Builder.name

Undocumented

supported_image_types: list[str] = (source)
overrides sphinx.builders.Builder.supported_image_types

Undocumented

supported_remote_images: bool = (source)
overrides sphinx.builders.Builder.supported_remote_images

Undocumented

babel = (source)

Undocumented

context = (source)

Undocumented

docnames = (source)

Undocumented

document_data: list[tuple[str, str, str, str, str, bool]] = (source)

Undocumented

themes = (source)

Undocumented

titles: list[tuple[str, str]] = (source)

Undocumented