docutils.transforms.universal.Decorations

class documentation

class Decorations(Transform): (source)

Constructor: Decorations(document, startnode)

View In Hierarchy

Populate a document's decoration element (header, footer).

Method apply Override to apply the transform to the document tree.
Method generate_footer Undocumented
Method generate_header Undocumented
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 generate_footer(self): (source)

Undocumented

def generate_header(self): (source)

Undocumented

default_priority: int = (source)
overrides docutils.transforms.Transform.default_priority

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