docutils.transforms.references.PropagateTargets Class Reference

Inheritance diagram for docutils.transforms.references.PropagateTargets:

Collaboration diagram for docutils.transforms.references.PropagateTargets:

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

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

Propagate empty internal targets to the next element.

Given the following nodes::

    <target ids="internal1" names="internal1">
    <target anonymous="1" ids="id1">
    <target ids="internal2" names="internal2">
    <paragraph>
        This is a test.

`PropagateTargets` propagates the ids and names of the internal
targets preceding the paragraph to the paragraph itself::

    <target refid="internal1">
    <target anonymous="1" refid="id1">
    <target refid="internal2">
    <paragraph ids="internal2 id1 internal1" names="internal2 internal1">
        This is a test.

Member Function Documentation

apply()

docutils.transforms.references.PropagateTargets.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