.. training-noodles documentation master file, created by
   sphinx-quickstart on Sun Jun  9 19:32:34 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Training Noodles documentation!
============================================

Training Noodles is a simple and powerful tool to help training **multiple**
programs on **multiple** servers.

Links
-----

* `GitHub repository`_
* `PyPI package page`_

.. toctree::
   :caption: Introduction
   :maxdepth: 2
   :numbered:

   introduction/introduction
   introduction/use_case
   introduction/how_noodles_works

.. toctree::
   :caption: User Guide
   :maxdepth: 2
   :numbered:

   guide/installation
   guide/linux_terminal_for_windows
   guide/usage
   guide/write_a_minimalist_spec_file
   guide/see_other_examples
   guide/caveats

.. toctree::
   :caption: References
   :maxdepth: 2
   :numbered:

   references/command_line_arguments
   references/spec_options
   references/environment_variables

Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`

.. _GitHub repository: https://github.com/elsa-lab/training-noodles
.. _PyPI package page: https://pypi.org/project/training-noodles/