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.

Contents:

• Quickstart
• How-Tos
• Reference
• ChangeLog
• Development

How-Tos

More specific How-Tos:

• Change working directory
• Test commands
• Run a tutorial with Vagrant