docutils.transforms.writer_aux.Admonitions Class Reference

Inheritance diagram for docutils.transforms.writer_aux.Admonitions:

Collaboration diagram for docutils.transforms.writer_aux.Admonitions:

Public Member Functions
	apply (self)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Static Public Attributes
int	default_priority = 920
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

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.

Member Function Documentation

apply()

docutils.transforms.writer_aux.Admonitions.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/writer_aux.py