sphinx.builders.latex.transforms.IndexInSectionTitleTransform

class documentation

class IndexInSectionTitleTransform(SphinxPostTransform):

View In Hierarchy

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 .Sphinx object.
Property config Reference to the .Config object.
Property env Reference to the .BuildEnvironment object.
def run(self, **kwargs):
overrides sphinx.transforms.post_transforms.SphinxPostTransform.run

Main method of post transforms.

Subclasses should override this method instead of apply().

Parameters
**kwargs:AnyUndocumented
default_priority: int =

Undocumented

formats: tuple[str, ...] =
overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented