docutils.transforms.frontmatter.TitlePromoter Class Reference

Inheritance diagram for docutils.transforms.frontmatter.TitlePromoter:

Collaboration diagram for docutils.transforms.frontmatter.TitlePromoter:

Public Member Functions
	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)
	apply (self, **kwargs)

Additional Inherited Members
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Detailed Description

Abstract base class for DocTitle and SectionSubTitle transforms.

Member Function Documentation

candidate_index()

docutils.transforms.frontmatter.TitlePromoter.candidate_index	(		self,
			node
	)

Find and return the promotion candidate and its index.

Return (None, None) if no valid candidate was found.

promote_subtitle()

docutils.transforms.frontmatter.TitlePromoter.promote_subtitle	(		self,
			node
	)

Transform the following node tree::

    <node>
        <title>
        <section>
            <title>
            ...

into ::

    <node>
        <title>
        <subtitle>
        ...

promote_title()

docutils.transforms.frontmatter.TitlePromoter.promote_title	(		self,
			node
	)

Transform the following tree::

    <node>
        <section>
            <title>
            ...

into ::

    <node>
        <title>
        ...

`node` is normally a document.

---

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

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