module sphinxext.sphinx_latex_builder

Short summary

module pyquickhelper.sphinxext.sphinx_latex_builder

Overwrites latex writer as Sphinx’s version is bugged in version 1.8.0.

Classes

class	truncated documentation
CustomizedSphinxFileOutput	Customized FileOutput class for Sphinx.
EnhancedLaTeXBuilder	Overwrites LaTeXBuilder.
EnhancedLaTeXTranslator	Overwrites LaTeXTranslator and modifies …
EnhancedLaTeXWriter	Overwrites LatexWriter.

Functions

function	truncated documentation
setup	Initializes builder EnhancedLaTeXBuilder.

Properties

property	truncated documentation
bibitems
footnotestack
hlsettingstack
in_container_literal_block
next_hyperlink_ids
next_section_ids

Methods

method	truncated documentation
__init__
__init__	Constructor, add a logger.
__init__
__init__
_get_filename
add_text
depart_inheritance_diagram
depart_only
eval_expr
finish
get_outfilename	Overwrites get_target_uri to control file names.
latex_image_length
translate
unknown_visit
visit_document
visit_enumerated_list
visit_inheritance_diagram
visit_only
write
write

Documentation

Overwrites latex writer as Sphinx’s version is bugged in version 1.8.0.

New in version 1.8.

source on GitHub

class pyquickhelper.sphinxext.sphinx_latex_builder.CustomizedSphinxFileOutput(**kwargs)

Bases: sphinx.util.docutils.SphinxFileOutput

Customized FileOutput class for Sphinx.

source on GitHub

Parameters

• destination: either a file-like object (which is written directly) or None (which implies sys.stdout if no destination_path given).

• destination_path: a path to a file, which is opened and then written.

• encoding: the text encoding of the output file.

• error_handler: the encoding error handler to use.

• autoclose: close automatically after write (except when sys.stdout or sys.stderr is the destination).

• handle_io_errors: ignored, deprecated, will be removed.

• mode: how the file is to be opened (see standard function open). The default is ‘w’, providing universal newline support for text files.

__init__(**kwargs)

Parameters

• destination: either a file-like object (which is written directly) or None (which implies sys.stdout if no destination_path given).

• destination_path: a path to a file, which is opened and then written.

• encoding: the text encoding of the output file.

• error_handler: the encoding error handler to use.

• autoclose: close automatically after write (except when sys.stdout or sys.stderr is the destination).

• handle_io_errors: ignored, deprecated, will be removed.

• mode: how the file is to be opened (see standard function open). The default is ‘w’, providing universal newline support for text files.

write(data)

Encode data, write it to a single file, and return it.

With Python 3 or binary output mode, data is returned unchanged, except when specified encoding and output encoding differ.

class pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXBuilder(*args, **kwargs)

Bases: sphinx.builders.latex.LaTeXBuilder

Overwrites LaTeXBuilder.

source on GitHub

Constructor, add a logger.

source on GitHub

__init__(*args, **kwargs)

Constructor, add a logger.

source on GitHub

_get_filename(targetname, encoding='utf-8', overwrite_if_changed=True)

default_translator_class

alias of EnhancedLaTeXTranslator

depart_autosignature_node(node)

What to do when leaving a node autosignature_node.

source on GitHub

depart_bigger_node(node)

depart bigger_node for latex

source on GitHub

depart_blocref_node(node)

depart_blocref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_blocreflist(node)

depart_blocref_node

source on GitHub

depart_blogpost_node(node)

what to do when leaving a node blogpost the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

depart_blogpostagg_node(node)

what to do when leaving a node blogpost, the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

depart_cmdref_node(node)

depart_cmdref_node, see sphinx/writers/html.py.

source on GitHub

depart_cmdreflist(node)

depart_cmdref_node

source on GitHub

depart_collapse_node(node)

depart collapse_node

source on GitHub

depart_downloadlink_node(node)

Does notthing.

source on GitHub

depart_epkg_node(node)

What to do when leaving a node epkg.

source on GitHub

depart_exref_node(node)

depart_exref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_exreflist(node)

depart_exref_node

source on GitHub

depart_faqref_node(node)

depart_faqref_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_faqreflist(node)

depart_faqref_node

source on GitHub

depart_gitlog_node(node)

depart gitlog_node for latex

source on GitHub

depart_mathdef_node(node)

depart_mathdef_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_mathdeflist(node)

depart_mathdef_node

source on GitHub

depart_nbref_node(node)

depart_nbref_node, see sphinx/writers/html.py.

source on GitHub

depart_nbreflist(node)

depart_nbref_node

source on GitHub

depart_postcontents_node(node)

does nothing

source on GitHub

depart_quote_node(node)

depart_quote_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_runpython_node(node)

What to do when leaving a node runpython_node the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

depart_sharenet_node(node)

what to do when leaving a node sharenet the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

It does only html for the time being.

source on GitHub

depart_simpleimage_node(node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

depart_tocdelay_node(node)

does nothing

source on GitHub

depart_todoext_node(node)

depart_todoext_node, see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

depart_todoextlist(node)

depart_todoext_node

source on GitHub

depart_tpl_node(node)

What to do when leaving a node tpl.

source on GitHub

depart_video_node(node)

What to do when leaving a node video the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

depart_youtube_node(node)

Youtube node.

source on GitHub

finish()

Finish the building process.

The default implementation does nothing.

get_outfilename(pagename)

Overwrites get_target_uri to control file names.

source on GitHub

visit_autosignature_node(node)

What to do when visiting a node autosignature_node.

source on GitHub

visit_bigger_node(node)

what to do when visiting a node bigger the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_blocref_node(node)

source on GitHub

visit_blocreflist(node)

visit_blocreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

visit_blogpost_node(node)

what to do when visiting a node blogpost the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_blogpostagg_node(node)

what to do when visiting a node blogpost the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_cmdref_node(node)

source on GitHub

visit_cmdreflist(node)

visit_cmdreflist_node see sphinx/writers/html.py.

source on GitHub

visit_collapse_node(node)

visit collapse_node

source on GitHub

visit_downloadlink_node(node)

Does notthing.

source on GitHub

visit_epkg_node(node)

What to do when visiting a node epkg.

source on GitHub

visit_exref_node(node)

source on GitHub

visit_exreflist(node)

visit_exreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

visit_faqref_node(node)

source on GitHub

visit_faqreflist(node)

visit_faqreflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

visit_gitlog_node(node)

what to do when visiting a node gitlog the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_mathdef_node(node)

source on GitHub

visit_mathdeflist(node)

visit_mathdeflist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

visit_nbref_node(node)

source on GitHub

visit_nbreflist(node)

visit_nbreflist_node, see sphinx/writers/html.py.

source on GitHub

visit_postcontents_node(node)

does nothing

source on GitHub

visit_quote_node(node)

source on GitHub

visit_runpython_node(node)

What to do when visiting a node runpython_node the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_sharenet_node(node)

what to do when visiting a node sharenet the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

visit_simpleimage_node(node)

Visits a image node. Copies the image.

source on GitHub

visit_tocdelay_node(node)

does nothing

source on GitHub

visit_todoext_node(node)

source on GitHub

visit_todoextlist(node)

visit_todoextlist_node see https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/html.py

source on GitHub

visit_tpl_node(node)

What to do when visiting a node tpl.

source on GitHub

visit_video_node(node)

Visits a video node. Copies the video.

source on GitHub

visit_youtube_node(node)

Visit youtube node (html).

source on GitHub

class pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXTranslator(builder, document)

Bases: sphinx.writers.latex.LaTeXTranslator

Overwrites LaTeXTranslator and modifies a few functions.

source on GitHub

__init__(builder, document)

Initialize self. See help(type(self)) for accurate signature.

unknown_visit(node)

Called when entering unknown Node types.

Raise an exception unless overridden.

class pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXWriter(builder)

Bases: sphinx.writers.latex.LaTeXWriter

Overwrites LatexWriter.

source on GitHub

__init__(builder)

Initialize self. See help(type(self)) for accurate signature.

translate()

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

translator_class

alias of EnhancedLaTeXTranslator

pyquickhelper.sphinxext.sphinx_latex_builder.setup(app)

Initializes builder EnhancedLaTeXBuilder.

source on GitHub