Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,16 @@ 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
~~~~~~~~~~~~~~~~
.. _example_model:

The yMMSL file is processed and generates the following documentation:
:ref:`Converted Output: yMMSL Example Model Documentation <example_model>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. toctree::
:maxdepth: 1
:maxdepth: 4

examples/example_model
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This allows you to maintain your yMMSL files and automatically generate human-re
For more information about yMMSL files and the yMMSL language specification, see the `yMMSL documentation <https://ymmsl-python.readthedocs.io/en/develop/index.html>`_.

.. toctree::
:maxdepth: 2
:maxdepth: 4
:caption: Contents:

get_started
Expand Down