class documentation

class ExternalLinksChecker(SphinxPostTransform): (source)

View In Hierarchy

For each external link, check if it can be replaced by an extlink. We treat each ``reference`` node without ``internal`` attribute as an external link.

Method check_uri If the URI in ``refnode`` has a replacement in ``extlinks``, emit a warning with a replacement suggestion.
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 check_uri(self, refnode): (source)

If the URI in ``refnode`` has a replacement in ``extlinks``, emit a warning with a replacement suggestion.

Parameters
refnode:nodes.referenceUndocumented
def run(self, **kwargs): (source)

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

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

Undocumented