sphinx.transforms.SphinxTransform

class documentation

class SphinxTransform(Transform): (source)

Known subclasses: sphinx.builders.latex.transforms.FootnoteDocnameUpdater, sphinx.domains.c.AliasTransform, sphinx.domains.citation.CitationDefinitionTransform, sphinx.domains.citation.CitationReferenceTransform, sphinx.domains.cpp.AliasTransform, sphinx.transforms.ApplySourceWorkaround, sphinx.transforms.AutoIndexUpgrader, sphinx.transforms.AutoNumbering, sphinx.transforms.compact_bullet_list.RefOnlyBulletListTransform, sphinx.transforms.DefaultSubstitutions, sphinx.transforms.DoctestTransform, sphinx.transforms.DoctreeReadEvent, sphinx.transforms.ExtraTranslatableNodes, sphinx.transforms.FilterSystemMessages, sphinx.transforms.GlossarySorter, sphinx.transforms.HandleCodeBlocks, sphinx.transforms.i18n.Locale, sphinx.transforms.i18n.PreserveTranslatableMessages, sphinx.transforms.i18n.RemoveTranslatableInline, sphinx.transforms.ManpageLink, sphinx.transforms.MoveModuleTargets, sphinx.transforms.post_transforms.code.HighlightLanguageTransform, sphinx.transforms.post_transforms.code.TrimDoctestFlagsTransform, sphinx.transforms.post_transforms.images.BaseImageConverter, sphinx.transforms.post_transforms.SphinxPostTransform, sphinx.transforms.references.SphinxDomains, sphinx.transforms.SortIds, sphinx.transforms.SphinxSmartQuotes, sphinx.transforms.UnreferencedFootnotesDetector, sphinx.versioning.UIDTransform

View In Hierarchy

A base class of Transforms. Compared with ``docutils.transforms.Transform``, this class improves accessibility to Sphinx APIs.

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
@property
app: Sphinx = (source)

Reference to the :class:`.Sphinx` object.

@property
config: Config = (source)

Reference to the :class:`.Config` object.

@property
env: BuildEnvironment = (source)

Reference to the :class:`.BuildEnvironment` object.