sphinx.transforms

package documentation

Docutils transforms used by Sphinx when reading documents.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Package post​_transforms sphinx.transforms.post_transforms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module compact​_bullet​_list sphinx.transforms.compact_bullet_list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Module i18n sphinx.transforms.i18n ~~~~~~~~~~~~~~~~~~~~~~
Module references sphinx.transforms.references ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From __init__.py:

Class ​Sphinx​Transform A base class of Transforms.
Constant TRANSLATABLE​_NODES Undocumented
Variable default​_substitutions Undocumented
Variable logger Undocumented
Class ​Apply​Source​Workaround Update source and rawsource attributes
Class ​Auto​Index​Upgrader Detect old style (4 column based indices) and automatically upgrade to new style.
Class ​Auto​Numbering Register IDs of tables, figures and literal_blocks to assign numbers.
Class ​Default​Substitutions Replace some substitutions if they aren't defined in the document.
Class ​Doctest​Transform Set "doctest" style to each doctest_block node
Class ​Doctree​Read​Event Emit :event:`doctree-read` event.
Class ​Extra​Translatable​Nodes Make nodes translatable
Class ​Figure​Aligner Align figures to center by default.
Class ​Filter​System​Messages Filter system messages from a doctree.
Class ​Glossary​Sorter Sort glossaries that have the sorted flag.
Class ​Handle​Code​Blocks Several code block related transformations.
Class ​Manpage​Link Find manpage section numbers and names
Class ​Move​Module​Targets Move module targets that are the first thing in a section to the section title.
Class ​Sort​Ids Sort section IDs so that the "id[0-9]+" one comes last.
Class ​Sphinx​Contents​Filter Used with BuildEnvironment.add_toc_from() to discard cross-file links within table-of-contents link nodes.
Class ​Sphinx​Smart​Quotes Customized SmartQuotes to avoid transform for some extra node types.
Class ​Sphinx​Transformer A transformer for Sphinx.
Class ​Unreferenced​Footnotes​Detector Detect unreferenced footnotes and emit warnings
Function setup Undocumented
logger =

Undocumented

default_substitutions: set[str] =

Undocumented

TRANSLATABLE_NODES =

Undocumented

Value
{'literal-block': nodes.literal_block,
 'doctest-block': nodes.doctest_block,
 'raw': nodes.raw,
 'index': addnodes.index,
 'image': nodes.image}
def setup(app):

Undocumented

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