docutils.transforms.references.TargetNotes

class documentation

class TargetNotes(Transform): (source)

View In Hierarchy

Creates a footnote for each external target in the text, and corresponding footnote references after each reference.
Method __init__ Initial setup for in-place document transforms.
Method apply Override to apply the transform to the document tree.
Method make​_target​_footnote Undocumented
Class Variable default​_priority The TargetNotes transform has to be applied after IndirectHyperlinks but before Footnotes.
Instance Variable classes Undocumented

Inherited from Transform:

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 __init__(self, document, startnode): (source)
overrides docutils.transforms.Transform.__init__
Initial setup for in-place document transforms.
def apply(self): (source)
overrides docutils.transforms.Transform.apply
Override to apply the transform to the document tree.
def make_target_footnote(self, refuri, refs, notes): (source)

Undocumented

default_priority: int = (source)
overrides docutils.transforms.Transform.default_priority
The TargetNotes transform has to be applied after IndirectHyperlinks but before Footnotes.
classes = (source)

Undocumented