docutils.transforms Namespace Reference

Namespaces
namespace	components
namespace	frontmatter
namespace	misc
namespace	parts
namespace	peps
namespace	references
namespace	universal
namespace	writer_aux

Classes
class	Transform
class	Transformer
class	TransformError

Detailed Description

This package contains modules for standard tree transforms available
to Docutils components. Tree transforms serve a variety of purposes:

- To tie up certain syntax-specific "loose ends" that remain after the
  initial parsing of the input plaintext. These transforms are used to
  supplement a limited syntax.

- To automate the internal linking of the document tree (hyperlink
  references, footnote references, etc.).

- To extract useful information from the document tree. These
  transforms may be used to construct (for example) indexes and tables
  of contents.

Each transform is an optional step that a Docutils component may
choose to perform on the parsed document.