oasislmf.utils.documentation.jsontomd.base
==========================================

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


Classes
-------

.. autoapisummary::

   oasislmf.utils.documentation.jsontomd.base.BaseJsonToMarkdownGenerator


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

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

   Bases: :py:obj:`abc.ABC`


   Base JSON to Markdown Generator class


   .. py:attribute:: full_schema


   .. py:attribute:: data_path


   .. py:attribute:: doc_out_dir


   .. py:attribute:: md
      :value: None



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


      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