docutils.transforms.references.Substitutions Class Reference

Inheritance diagram for docutils.transforms.references.Substitutions:

Collaboration diagram for docutils.transforms.references.Substitutions:

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

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

Given the following ``document`` as input::

    <document>
        <paragraph>
            The
            <substitution_reference refname="biohazard">
                biohazard
             symbol is deservedly scary-looking.
        <substitution_definition name="biohazard">
            <image alt="biohazard" uri="biohazard.png">

The ``substitution_reference`` will simply be replaced by the
contents of the corresponding ``substitution_definition``.

The transformed result will be::

    <document>
        <paragraph>
            The
            <image alt="biohazard" uri="biohazard.png">
             symbol is deservedly scary-looking.
        <substitution_definition name="biohazard">
            <image alt="biohazard" uri="biohazard.png">

Member Function Documentation

apply()

docutils.transforms.references.Substitutions.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/references.py