Examples
========

This section shows several examples of how yMMSL files are converted into Markdown documentation.

Macro-Micro Model
-----------------

Below is an example of a macro-micro model, this example was taken from the `yMMSL documentation <https://ymmsl-python.readthedocs.io/en/develop/basic_usage.html>`_.

Input File
~~~~~~~~~~

.. literalinclude:: examples/example_model.ymmsl
   :language: yaml
   :caption: example_model.ymmsl

Converted Output
~~~~~~~~~~~~~~~~

The yMMSL file is processed and generates the following documentation:

.. toctree::
   :maxdepth: 1

   examples/example_model