docutils.transforms.writer_aux.Compound

class documentation

class Compound(Transform): (source)

View In Hierarchy

.. warning:: This transform is not used by Docutils since Dec 2010 and will be removed in Docutils 0.21 or later. Flatten all compound paragraphs. For example, transform :: <compound> <paragraph> <literal_block> <paragraph> into :: <paragraph> <literal_block classes="continued"> <paragraph classes="continued">

Method __init__ Initial setup for in-place document transforms.
Method apply Override to apply the transform to the document tree.
Class Variable default_priority Numerical priority of this transform, 0 through 999 (override).

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=None): (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.

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

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