docutils.transforms.Transform Class Reference

Inheritance diagram for docutils.transforms.Transform:

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

Public Attributes
	document
	startnode
	language

Static Public Attributes
	default_priority = None

Detailed Description

Docutils transform component abstract base class.

Constructor & Destructor Documentation

__init__()

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

Initial setup for in-place document transforms.

Reimplemented in docutils.transforms.references.TargetNotes, docutils.transforms.universal.SmartQuotes, and docutils.transforms.writer_aux.Compound.

Member Function Documentation

apply()

docutils.transforms.Transform.apply	(		self,
		**	kwargs
	)

Override to apply the transform to the document tree.

Reimplemented in docutils.transforms.components.Filter, docutils.transforms.frontmatter.DocTitle, docutils.transforms.frontmatter.SectionSubTitle, docutils.transforms.frontmatter.DocInfo, docutils.transforms.misc.CallBack, docutils.transforms.misc.ClassAttribute, docutils.transforms.misc.Transitions, docutils.transforms.parts.SectNum, docutils.transforms.parts.Contents, docutils.transforms.peps.Headers, docutils.transforms.peps.Contents, docutils.transforms.peps.TargetNotes, docutils.transforms.peps.PEPZero, docutils.transforms.references.PropagateTargets, docutils.transforms.references.AnonymousHyperlinks, docutils.transforms.references.IndirectHyperlinks, docutils.transforms.references.ExternalTargets, docutils.transforms.references.InternalTargets, docutils.transforms.references.Footnotes, docutils.transforms.references.Substitutions, docutils.transforms.references.TargetNotes, docutils.transforms.references.DanglingReferences, docutils.transforms.universal.Decorations, docutils.transforms.universal.ExposeInternals, docutils.transforms.universal.Messages, docutils.transforms.universal.FilterMessages, docutils.transforms.universal.TestMessages, docutils.transforms.universal.StripComments, docutils.transforms.universal.StripClassesAndElements, docutils.transforms.universal.SmartQuotes, docutils.transforms.writer_aux.Compound, docutils.transforms.writer_aux.Admonitions, sphinx.builders.latex.transforms.FootnoteDocnameUpdater, sphinx.domains.c.AliasTransform, sphinx.domains.citation.CitationDefinitionTransform, sphinx.domains.citation.CitationReferenceTransform, sphinx.domains.cpp.AliasTransform, sphinx.transforms.DefaultSubstitutions, sphinx.transforms.MoveModuleTargets, sphinx.transforms.HandleCodeBlocks, sphinx.transforms.AutoNumbering, sphinx.transforms.SortIds, sphinx.transforms.ApplySourceWorkaround, sphinx.transforms.AutoIndexUpgrader, sphinx.transforms.ExtraTranslatableNodes, sphinx.transforms.UnreferencedFootnotesDetector, sphinx.transforms.DoctestTransform, sphinx.transforms.FilterSystemMessages, sphinx.transforms.SphinxSmartQuotes, sphinx.transforms.DoctreeReadEvent, sphinx.transforms.GlossarySorter, sphinx.transforms.ReorderConsecutiveTargetAndIndexNodes, sphinx.transforms.compact_bullet_list.RefOnlyBulletListTransform, sphinx.transforms.i18n.PreserveTranslatableMessages, sphinx.transforms.i18n.Locale, sphinx.transforms.i18n.TranslationProgressTotaliser, sphinx.transforms.i18n.AddTranslationClasses, sphinx.transforms.i18n.RemoveTranslatableInline, sphinx.transforms.post_transforms.SphinxPostTransform, sphinx.transforms.post_transforms.code.HighlightLanguageTransform, sphinx.transforms.post_transforms.code.TrimDoctestFlagsTransform, sphinx.transforms.post_transforms.images.BaseImageConverter, sphinx.transforms.references.SphinxDanglingReferences, sphinx.transforms.references.SphinxDomains, sphinx.versioning.UIDTransform, myst_parser.mdit_to_docutils.transforms.UnreferencedFootnotesDetector, myst_parser.mdit_to_docutils.transforms.SortFootnotes, myst_parser.mdit_to_docutils.transforms.CollectFootnotes, and myst_parser.mdit_to_docutils.transforms.ResolveAnchorIds.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/__init__.py