oasislmf.computation.generate.doc
=================================

.. py:module:: oasislmf.computation.generate.doc


Classes
-------

.. autoapisummary::

   oasislmf.computation.generate.doc.GenerateModelDocumentation


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

.. py:class:: GenerateModelDocumentation(**kwargs)

   Bases: :py:obj:`oasislmf.computation.base.ComputationStep`


   Generates Model Documentation from schema provided in the model config file


   .. py:attribute:: step_params


   .. py:attribute:: chained_commands
      :value: []



   .. py:method:: validate_doc_schema(schema_path, docjson_path)

      Validates docjson_path file with schema_path file
      Args:
          schema_path (str | os.PathLike): Schema path file
          docjson_path (str | os.PathLike): Documentation JSON path file
      Returns:
          docjson (Dict): Json data loaded as a dictionary



   .. py:method:: json_to_mdtxt(json_data, full_schema, data_path, doc_out_dir)

      Convert json data to markdown text with schemas provided
      Args:
          json_data (dict): Json data as dictionary
          full_schema (dict): Full schema file as dictionary
          data_path (str | os.PathLike): Path to data folder for any relative file paths
          doc_out_dir (str | os.PathLike): Path to documentation file output folder for any relative file paths



   .. py:method:: run()