oasislmf.utils.documentation.jsontomd.default

Classes

DefaultJsonToMarkdownGenerator

Default JSON to Markdown Generator class.

Module Contents

class oasislmf.utils.documentation.jsontomd.default.DefaultJsonToMarkdownGenerator(full_schema, data_path, doc_out_dir, markdown_generator=None)

Bases: oasislmf.utils.documentation.jsontomd.BaseJsonToMarkdownGenerator

Default JSON to Markdown Generator class. Naively iterates through the dict and outputs with limited formatting.

json_array_to_mdtable(data, ref)

generate_data(data, properties_schema, header_level)

generate(json_data, generate_toc=False)

Top level function to process entire dict to markdown text

Parameters:

• json_data (Dict) – Json data as dictionary

• generate_toc (bool, Optional) – Generate table of contents bool. Defaults to False.

Returns:

Markdown text

Return type:

markdown_txt (str)