oasislmf.utils.documentation.jsontomd.base¶

Classes¶

BaseJsonToMarkdownGenerator

Base JSON to Markdown Generator class

Module Contents¶

class oasislmf.utils.documentation.jsontomd.base.BaseJsonToMarkdownGenerator(full_schema, data_path, doc_out_dir, markdown_generator=None)[source]¶

Bases: abc.ABC

Base JSON to Markdown Generator class

full_schema[source]¶

data_path[source]¶

doc_out_dir[source]¶

md = None[source]¶

abstract generate(json_data, generate_toc=False)[source]¶

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)