structured-tutorials documentation
==================================

`structured-tutorials` allows you to write tutorials that can be rendered as documentation and run on your
system to verify correctness.

With `structured-tutorials` you to specify steps (commands, files to create, ...) in a YAML file. A Sphinx
plugin allows you to render them in your project documentation. A command-line tool can load the YAML file and
run it on your local system.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   /quickstart
   /how-tos
   /reference
   /changelog
   /dev

How-Tos
-------

.. toctree::
   :maxdepth: 1
   :caption: More specific How-Tos:

   /howto/chdir
   /howto/test-commands
   /howto/vagrant