oasislmf.utils.documentation.jsontomd.default
=============================================

.. py:module:: oasislmf.utils.documentation.jsontomd.default


Classes
-------

.. autoapisummary::

   oasislmf.utils.documentation.jsontomd.default.DefaultJsonToMarkdownGenerator


Module Contents
---------------

.. py:class:: DefaultJsonToMarkdownGenerator(full_schema, data_path, doc_out_dir, markdown_generator=None)

   Bases: :py:obj:`oasislmf.utils.documentation.jsontomd.BaseJsonToMarkdownGenerator`


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


   .. py:method:: json_array_to_mdtable(data, ref)


   .. py:method:: generate_data(data, properties_schema, header_level)


   .. py:method:: generate(json_data, generate_toc=False)

      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