sphinx.writers.latex

module documentation

Custom docutils writer for LaTeX.

Much of this code is adapted from Dave Kuhlman's "docpy" writer from his docutils sandbox.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant BLANKLINE Undocumented
Constant CR Undocumented
Constant ENUMERATE​_LIST​_STYLE Undocumented
Constant EXTRA​_RE Undocumented
Constant LATEXSECTIONNAMES Undocumented
Constant MAX​_CITATION​_LABEL​_LENGTH Undocumented
Variable logger Undocumented
Class collected​_footnote Footnotes that are collected are assigned this class.
Class ​La​Te​XTranslator No class docstring; 1/1 property, 0/32 instance variable, 0/4 class variable, 3/223 methods documented
Class ​La​Te​XWriter Undocumented
Class ​Table A table data
Class ​Table​Cell Data of a cell in a table.
Class ​Unsupported​Error Undocumented
Function escape​_abbr Adjust spacing after abbreviations.
Function rstdim​_to​_latexdim Convert width_str with rst length to LaTeX length.
BLANKLINE: str =

Undocumented

Value
'''

'''
CR: str =

Undocumented

Value
'''
'''
ENUMERATE_LIST_STYLE =

Undocumented

Value
defaultdict((lambda : '\\arabic'),
            {'arabic': '\\arabic',
             'loweralpha': '\\alph',
             'upperalpha': '\\Alph',
             'lowerroman': '\\roman',
             'upperroman': '\\Roman'})
EXTRA_RE =

Undocumented

Value
re.compile(r'^(.*\S)\s+\(([^\(\)]*)\)\s*$')
LATEXSECTIONNAMES: list[str] =

Undocumented

Value
['part',
 'chapter',
 'section',
 'subsection',
 'subsubsection',
 'paragraph',
 'subparagraph']
MAX_CITATION_LABEL_LENGTH: int =

Undocumented

Value
8
logger =

Undocumented

def escape_abbr(text):
Adjust spacing after abbreviations.
Parameters
text:strUndocumented
Returns
strUndocumented
def rstdim_to_latexdim(width_str, scale=100):
Convert width_str with rst length to LaTeX length.
Parameters
width​_str:strUndocumented
scale:intUndocumented
Returns
strUndocumented