docutils.transforms.peps.TargetNotes

class documentation

class TargetNotes(Transform): (source)

Constructor: TargetNotes(document, startnode)

Locate the "References" section, insert a placeholder for an external target footnote insertion transform at the end, and schedule the transform to run immediately.

Method	`apply`	Override to apply the transform to the document tree.
Method	`cleanup_callback`	Remove an empty "References" section.
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): (source) ¶

overrides docutils.transforms.Transform.apply

Override to apply the transform to the document tree.

def cleanup_callback(self, pending): (source) ¶

Remove an empty "References" section.

Called after the references.TargetNotes transform is complete.

default_priority: int = (source) ¶

overrides docutils.transforms.Transform.default_priority

Numerical priority of this transform, 0 through 999 (override).