oasislmf.utils.documentation.jsontomd.rdls_0__2__0

Attributes

logger

Classes

RDLS_0_2_0_JsonToMarkdownGenerator

Base JSON to Markdown Generator class

Module Contents

oasislmf.utils.documentation.jsontomd.rdls_0__2__0.logger[source]
class oasislmf.utils.documentation.jsontomd.rdls_0__2__0.RDLS_0_2_0_JsonToMarkdownGenerator(full_schema, data_path, doc_out_dir, markdown_generator=None)[source]

Bases: oasislmf.utils.documentation.jsontomd.base.BaseJsonToMarkdownGenerator

Base JSON to Markdown Generator class

json_array_to_mdtable(data, ref)[source]
generate_ds_overview(data, properties_schema, header_level)[source]
generate_ds_risk_data_properties(data, properties_schema, header_level)[source]
generate_ds_spatial_temporal_properties(data, properties_schema, header_level)[source]
generate_ds_resources_properties(data, properties_schema, header_level)[source]
generate_ds_owner_contact_properties(data, properties_schema, header_level)[source]
generate_ds_licensing_links_properties(data, properties_schema, header_level)[source]
generate_dataset(data, properties_schema, header_level)[source]
generate(json_data, generate_toc=False)[source]

Top level function to process entire dict to markdown text Args:

json_data (Dict): Json data as dictionary generate_toc (bool, Optional): Generate table of contents bool. Defaults to False.

Returns:

markdown_txt (str): Markdown text