display_file

glotaran.utils.ipython.display_file(path: str | PathLike[str], *, syntax: str = None) → MarkdownStr[source]

Display a file with syntax highlighting syntax.

Parameters

  • path (str | PathLike[str]) – Paths to the file

  • syntax (str) – Syntax highlighting which should be applied, by default None

Returns

File content with syntax highlighting to render in ipython.

Return type

MarkdownStr