docutils.transforms.frontmatter.SectionSubTitle

class documentation

class SectionSubTitle(TitlePromoter): (source)

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.

Method	`apply`	Override to apply the transform to the document tree.
Class Variable	`default_priority`	Numerical priority of this transform, 0 through 999 (override).

Inherited from TitlePromoter:

Method	`candidate_index`	Find and return the promotion candidate and its index.
Method	`promote_subtitle`	Transform the following node tree:
Method	`promote_title`	Transform the following tree:

Inherited from Transform (via TitlePromoter):

Method	`__init__`	Initial setup for in-place document transforms.
Instance Variable	`document`	The document tree to transform.
Instance Variable	`language`	Language module local to this document.
Instance Variable	`startnode`	Node from which to begin the transform. For many transforms which apply to the document as a whole, `startnode` is not set (i.e. its value is `None`).

overrides docutils.transforms.Transform.apply

Override to apply the transform to the document tree.

overrides docutils.transforms.Transform.default_priority

Numerical priority of this transform, 0 through 999 (override).