equation_database.util.doc

Functions

add_latex(latex_str)
bib()
equation([summary, latex, description, ...])
indent_string(string[, n])
indent_string_twice(string)
table()

Classes

Param(name, description[, latex])

class equation_database.util.doc.Param(name: str, description: str, latex: str | None = None)

equation_database.util.doc.equation(summary: str | None = None, latex=None, description: str | None = None, args: list[Param] | None = None, tags: list[str] | None = None)

Parameters:

• summary – Short summary of the equation

• latex – Optional LaTeX override

• description – Longer description of the equation

• args – List of parameters with their descriptions and optional LaTeX

• tags – List of tags for categorization