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 |
---|---|
Customized FileOutput class for Sphinx. |
|
Overwrites LaTeXBuilder. |
|
Overwrites LaTeXTranslator and modifies … |
|
Overwrites LatexWriter. |
Properties¶
property |
truncated documentation |
---|---|
|
|
|
Get current table. |
|
|
|
Methods¶
method |
truncated documentation |
---|---|
Constructor, add a logger. |
|
|
|
|
|
|
|
|
|
Overwrites get_target_uri to control file names. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Documentation¶
Overwrites latex writer as Sphinx’s version is bugged in version 1.8.0.
New in version 1.8.
-
class
pyquickhelper.sphinxext.sphinx_latex_builder.
CustomizedSphinxFileOutput
(**kwargs)[source]¶ Bases:
sphinx.util.docutils.SphinxFileOutput
Customized FileOutput class for Sphinx.
- 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)[source]¶ - 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.
-
class
pyquickhelper.sphinxext.sphinx_latex_builder.
EnhancedLaTeXBuilder
(*args, **kwargs)[source]¶ Bases:
sphinx.builders.latex.LaTeXBuilder
Overwrites LaTeXBuilder.
Constructor, add a logger.
-
default_translator_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXTranslator
-
-
class
pyquickhelper.sphinxext.sphinx_latex_builder.
EnhancedLaTeXTranslator
(builder, document)[source]¶ Bases:
sphinx.writers.latex.LaTeXTranslator
Overwrites LaTeXTranslator and modifies a few functions.
-
class
pyquickhelper.sphinxext.sphinx_latex_builder.
EnhancedLaTeXWriter
(builder)[source]¶ Bases:
sphinx.writers.latex.LaTeXWriter
Overwrites LatexWriter.
-
translate
()[source]¶ 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
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_latex_builder.EnhancedLaTeXTranslator
-
-
pyquickhelper.sphinxext.sphinx_latex_builder.
setup
(app)[source]¶ Initializes builder
EnhancedLaTeXBuilder
.