reno.utils.latex_name

reno.utils.latex_name(name, cmd='text')

Wrap a reference name in a latex string, correctly escaping anything as necessary. It will _not_ escape if there’s a ‘$’, indicating ‘yes use mathmode’ like in latex. This allows reference labels like “$x_3$”

Example

>>> latex_name("testing")
"\text{testing}"

>>> latex_name("x_3", "texttt")
"\texttt{x\_3}"

Parameters:

• name (str)

• cmd (str)

Return type:

str