sphinx.transforms.post_transforms.SphinxPostTransform

class documentation

class SphinxPostTransform(SphinxTransform): (source)

Known subclasses: sphinx.builders.html.transforms.KeyboardTransform, sphinx.builders.latex.transforms.BibliographyTransform, sphinx.builders.latex.transforms.CitationReferenceTransform, sphinx.builders.latex.transforms.DocumentTargetTransform, sphinx.builders.latex.transforms.IndexInSectionTitleTransform, sphinx.builders.latex.transforms.LaTeXFootnoteTransform, sphinx.builders.latex.transforms.LiteralBlockTransform, sphinx.builders.latex.transforms.MathReferenceTransform, sphinx.builders.latex.transforms.ShowUrlsTransform, sphinx.builders.latex.transforms.SubstitutionDefinitionsRemover, sphinx.builders.linkcheck.HyperlinkCollector, sphinx.ext.extlinks.ExternalLinksChecker, sphinx.ext.viewcode.ViewcodeAnchorTransform, sphinx.transforms.post_transforms.OnlyNodeTransform, sphinx.transforms.post_transforms.PropagateDescDomain, sphinx.transforms.post_transforms.ReferencesResolver, sphinx.transforms.post_transforms.SigElementFallbackTransform

View In Hierarchy

A base class of post-transforms. Post transforms are invoked to modify the document to restructure it for outputting. They resolve references, convert images, do special transformation for each output formats and so on. This class helps to implement these post transforms.

Method apply Undocumented
Method is_supported Check this transform working for current builder.
Method run Main method of post transforms.
Class Variable builders Undocumented
Class Variable formats Undocumented

Inherited from SphinxTransform:

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def apply(self, **kwargs): (source)

Undocumented

Parameters
**kwargs:AnyUndocumented
def is_supported(self): (source)

Check this transform working for current builder.

Returns
boolUndocumented
def run(self, **kwargs): (source)
overridden in sphinx.builders.html.transforms.KeyboardTransform, sphinx.builders.latex.transforms.BibliographyTransform, sphinx.builders.latex.transforms.CitationReferenceTransform, sphinx.builders.latex.transforms.DocumentTargetTransform, sphinx.builders.latex.transforms.IndexInSectionTitleTransform, sphinx.builders.latex.transforms.LaTeXFootnoteTransform, sphinx.builders.latex.transforms.LiteralBlockTransform, sphinx.builders.latex.transforms.MathReferenceTransform, sphinx.builders.latex.transforms.ShowUrlsTransform, sphinx.builders.latex.transforms.SubstitutionDefinitionsRemover, sphinx.builders.linkcheck.HyperlinkCollector, sphinx.ext.extlinks.ExternalLinksChecker, sphinx.ext.viewcode.ViewcodeAnchorTransform, sphinx.transforms.post_transforms.OnlyNodeTransform, sphinx.transforms.post_transforms.PropagateDescDomain, sphinx.transforms.post_transforms.ReferencesResolver, sphinx.transforms.post_transforms.SigElementFallbackTransform

Main method of post transforms. Subclasses should override this method instead of ``apply()``.

Parameters
**kwargs:AnyUndocumented
builders: tuple[str, ...] = (source)
overridden in sphinx.builders.linkcheck.HyperlinkCollector

Undocumented

formats: tuple[str, ...] = (source)
overridden in sphinx.builders.html.transforms.KeyboardTransform, sphinx.builders.latex.transforms.BibliographyTransform, sphinx.builders.latex.transforms.CitationReferenceTransform, sphinx.builders.latex.transforms.DocumentTargetTransform, sphinx.builders.latex.transforms.IndexInSectionTitleTransform, sphinx.builders.latex.transforms.LaTeXFootnoteTransform, sphinx.builders.latex.transforms.LiteralBlockTransform, sphinx.builders.latex.transforms.MathReferenceTransform, sphinx.builders.latex.transforms.ShowUrlsTransform, sphinx.builders.latex.transforms.SubstitutionDefinitionsRemover

Undocumented