sphinx.builders.latex.transforms.ShowUrlsTransform

class documentation

class ShowUrlsTransform(SphinxPostTransform):

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

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

Property	`app`	Reference to the `.Sphinx` object.
Property	`config`	Reference to the `.Config` object.
Property	`env`	Reference to the `.BuildEnvironment` object.

def create_footnote(self, uri, docname):

Undocumented

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

def expand_show_urls(self):

Undocumented

def get_docname_for_node(self, node):

Undocumented

def renumber_footnotes(self):

Undocumented

def run(self, **kwargs):

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 =

Undocumented

formats: tuple[str, ...] =

overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented

expanded: bool =

Undocumented