sphinx.builders.latex.transforms.ShowUrlsTransform

class documentation

class ShowUrlsTransform(SphinxPostTransform): (source)

Expand references to inline text or footnotes. For more information, see :confval:`latex_show_urls`. .. note:: This transform is used for integrated doctree

Method	`create_footnote`	Undocumented
Method	`expand_show_urls`	Undocumented
Method	`get_docname_for_node`	Undocumented
Method	`renumber_footnotes`	Undocumented
Method	`run`	Main method of post transforms.
Class Variable	`default_priority`	Undocumented
Class Variable	`formats`	Undocumented
Instance Variable	`expanded`	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 :class:`.Sphinx` object.
Property	`config`	Reference to the :class:`.Config` object.
Property	`env`	Reference to the :class:`.BuildEnvironment` object.

def create_footnote(self, uri, docname): (source) ¶

Undocumented

Parameters
uri:`str`	Undocumented
docname:`str`	Undocumented
Returns
`tuple[nodes.footnote, nodes.footnote_reference]`	Undocumented

def expand_show_urls(self): (source) ¶

Undocumented

def get_docname_for_node(self, node): (source) ¶

Undocumented

Parameters
node:`Node`	Undocumented
Returns
`str`	Undocumented

def renumber_footnotes(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:`Any`	Undocumented

default_priority: int = (source) ¶

Undocumented

formats: tuple[str, ...] = (source) ¶

overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented

expanded: bool = (source) ¶

Undocumented