docutils.transforms.writer_aux.Compound Class Reference

Inheritance diagram for docutils.transforms.writer_aux.Compound:

Collaboration diagram for docutils.transforms.writer_aux.Compound:

Public Member Functions
	__init__ (self, document, startnode=None)
	apply (self)

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

.. 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">

Constructor & Destructor Documentation

__init__()

docutils.transforms.writer_aux.Compound.__init__	(		self,
			document,
			startnode = None
	)

Initial setup for in-place document transforms.

Reimplemented from docutils.transforms.Transform.

Member Function Documentation

apply()

docutils.transforms.writer_aux.Compound.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/writer_aux.py