LatexInline

class astropy.units.format.LatexInline(*args, **kwargs)

Bases: Latex

Output LaTeX to display the unit based on IAU style guidelines with negative powers.

Attempts to follow the IAU Style Manual and the ApJ and AJ style guide.

Attributes Summary

name

Methods Summary

to_string(unit[, fraction])

Convert a unit to its string representation.

Attributes Documentation

name: ClassVar[str] = 'latex_inline'

Methods Documentation

classmethod to_string(unit: UnitBase, fraction: bool | Literal['inline', 'multiline'] = False) → str

Convert a unit to its string representation.

Implementation for to_string.

Parameters:

unitUnitBase

The unit to convert.

fraction{False|True|’inline’|’multiline’}, optional

Options are as follows:

• False : display unit bases with negative powers as they are (e.g., km s-1);

• ‘inline’ or True : use a single-line fraction (e.g., km / s);

• ‘multiline’ : use a multiline fraction if possible (available for the latex, console and unicode formats; e.g., $\mathrm{\frac{km}{s}}$). If not possible, use ‘inline’.

Raises:

ValueError

If fraction is not recognized.