sphinx.ext.viewcode.ViewcodeAnchorTransform

class documentation

class ViewcodeAnchorTransform(SphinxPostTransform): (source)

View In Hierarchy

Convert or remove viewcode_anchor nodes depends on builder.

Method convert_viewcode_anchors Undocumented
Method remove_viewcode_anchors Undocumented
Method run Main method of post transforms.
Class Variable default_priority Undocumented

Inherited from SphinxPostTransform:

Method apply Undocumented
Method is_supported Check this transform working for current builder.
Class Variable builders Undocumented
Class Variable formats Undocumented

Inherited from SphinxTransform (via SphinxPostTransform):

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 convert_viewcode_anchors(self): (source)

Undocumented

def remove_viewcode_anchors(self): (source)

Undocumented

def run(self, **kwargs): (source)
overrides sphinx.transforms.post_transforms.SphinxPostTransform.run

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

Parameters
**kwargs:AnyUndocumented
default_priority: int = (source)

Undocumented