class documentation

class DocumentTargetTransform(SphinxPostTransform):

View In Hierarchy

Add :doc label to the first section of each document.
Method run Main method of post transforms.
Class Variable default​_priority Undocumented
Class Variable formats Undocumented

Inherited from SphinxPostTransform:

Method apply Undocumented
Method is​_supported Check this transform working for current builder.
Class Variable builders Undocumented

Inherited from SphinxTransform (via SphinxPostTransform):

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

Main method of post transforms.

Subclasses should override this method instead of apply().

Parameters
**kwargs:AnyUndocumented
default_priority: int =

Undocumented

formats: tuple[str, ...] =