docutils.transforms.frontmatter.SectionSubTitle Class Reference

Inheritance diagram for docutils.transforms.frontmatter.SectionSubTitle:

Collaboration diagram for docutils.transforms.frontmatter.SectionSubTitle:

Public Member Functions
	apply (self)
Public Member Functions inherited from docutils.transforms.frontmatter.TitlePromoter
	promote_title (self, node)
	promote_subtitle (self, node)
	candidate_index (self, node)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Static Public Attributes
int	default_priority = 350
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Additional Inherited Members
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Detailed Description

This works like document subtitles, but for sections.  For example, ::

    <section>
        <title>
            Title
        <section>
            <title>
                Subtitle
            ...

is transformed into ::

    <section>
        <title>
            Title
        <subtitle>
            Subtitle
        ...

For details refer to the docstring of DocTitle.

Member Function Documentation

apply()

docutils.transforms.frontmatter.SectionSubTitle.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/frontmatter.py