docutils.transforms.writer_aux.Admonitions

class documentation

class Admonitions(Transform):

View In Hierarchy

Transform specific admonitions, like this:

<note>
<paragraph>
Note contents ...

into generic admonitions, like this:

<admonition classes="note">
    <title>
        Note
    <paragraph>
        Note contents ...

The admonition title is localized.

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 Transform:

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).
def apply(self):
overrides docutils.transforms.Transform.apply
Override to apply the transform to the document tree.
default_priority: int =
overrides docutils.transforms.Transform.default_priority
Numerical priority of this transform, 0 through 999 (override).