Submodule doc

Extract docstrings from func.py to document the template functions.

class tmep.doc.FnDoc(name: str)[source]

Bases: object

name: str

synopsis: str | None

example: str | None

description: str | None

format(output_format: Literal['txt', 'rst'] = 'txt') → str[source]

class tmep.doc.FnDocCollection[source]

Bases: object

fn_docs: list[FnDoc]

fn_names: list[str]

format(output_format: Literal['txt', 'rst'] = 'txt') → str[source]: Retrieve a formated text string

tmep.doc.get_doc(doc: Literal['functions_rst', 'functions_txt', 'introduction_rst'] = 'functions_txt') → str[source]

Get the documentation in the specified format.

Parameters:: doc – The format of the documentation to retrieve. Default is functions_txt. Possible values are functions_rst, functions_txt, and introduction_rst.
Returns:: The documentation in the specified format.

tmep.doc.print_doc() → None[source]: Little command line interface to print the documentation.