zoomy_core.misc.description module

Rich description object for notebook-native rendering and document export.

Description holds markdown content and renders automatically in Jupyter via _repr_markdown_. Export to .md or .tex files for direct use in documents.

class zoomy_core.misc.description.Description(markdown)

Bases: object

Renderable description that Jupyter displays as markdown.

Parameters:

markdown (str) –

to_markdown()

Return raw markdown string.

Return type:

str

to_latex()

Convert to LaTeX document fragment.

Translates markdown headings, bold, and $$ blocks into LaTeX equivalents. The result can be pasted into a .tex file or included via \input{}.

Return type:

str

save(path)

Save to file. Format chosen by extension (.md or .tex).

Parameters:

path (str) –