sphinx.builders.latex.transforms.IndexInSectionTitleTransform

class documentation

class IndexInSectionTitleTransform(SphinxPostTransform): (source)

Move index nodes in section title to outside of the title. LaTeX index macro is not compatible with some handling of section titles such as uppercasing done on LaTeX side (cf. fncychap handling of ``\chapter``). Moving the index node to after the title node fixes that. Before:: <section> <title> blah blah <index entries=[...]/>blah <paragraph> blah blah blah ... After:: <section> <title> blah blah blah <index entries=[...]/> <paragraph> blah blah blah ...

Method	`run`	Main method of post transforms.
Class Variable	`default_priority`	Undocumented
Class Variable	`formats`	Undocumented

Inherited from SphinxPostTransform:

Method	`apply`	Undocumented
Method	`is_supported`	Check this transform working for current builder.
Class Variable	`builders`	Undocumented

Inherited from SphinxTransform (via SphinxPostTransform):

Property	`app`	Reference to the :class:`.Sphinx` object.
Property	`config`	Reference to the :class:`.Config` object.
Property	`env`	Reference to the :class:`.BuildEnvironment` object.

def run(self, **kwargs): (source) ¶

overrides sphinx.transforms.post_transforms.SphinxPostTransform.run

Main method of post transforms. Subclasses should override this method instead of ``apply()``.

Parameters
**kwargs:`Any`	Undocumented

default_priority: int = (source) ¶

Undocumented

formats: tuple[str, ...] = (source) ¶

overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented