.. include:: ../README.rst :end-before: when included in index.rst .. |plot| image:: images/plot_spec.png How the documentation is structured ----------------------------------- Documentation is split into four categories, accessible from links in the side-bar. .. rst-class:: columns Tutorials ~~~~~~~~~ Tutorials for installation, library and commandline usage. New users start here. .. toctree:: :caption: Tutorials :hidden: tutorials/installation tutorials/creating-a-spec tutorials/graphql-service .. rst-class:: columns How-to Guides ~~~~~~~~~~~~~ Practical step-by-step guides for the more experienced user. .. toctree:: :caption: How-to Guides :hidden: how-to/iterate-a-spec how-to/serialize-a-spec .. rst-class:: columns Explanations ~~~~~~~~~~~~ Explanation of how the library works and why it works that way. .. toctree:: :caption: Explanations :hidden: explanations/technical-terms explanations/why-stack-frames explanations/why-squash-can-change-path .. rst-class:: columns Reference ~~~~~~~~~ Technical reference material, for classes, methods, APIs, commands, and contributing to the project. .. toctree:: :caption: Reference :hidden: reference/api reference/contributing Changelog Index .. rst-class:: endcolumns About the documentation ~~~~~~~~~~~~~~~~~~~~~~~ `Why is the documentation structured this way? `_