diff --git a/docs/index.rst b/docs/index.rst index 51f29ac..a44fc69 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ The documentation is split into 4 sections: .. toctree:: :maxdepth: 2 - tutorials + tutorial +++ @@ -25,9 +25,13 @@ The documentation is split into 4 sections: .. grid-item-card:: :material-regular:`task;3em` .. toctree:: + :caption: How-to Guides :maxdepth: 1 - + developer/how-to/contribute + developer/how-to/update-tools + developer/how-to/make-release + developer/how-to/run-container +++ @@ -36,9 +40,10 @@ The documentation is split into 4 sections: .. grid-item-card:: :material-regular:`info;3em` .. toctree:: + :caption: Explanations :maxdepth: 1 - - + + developer/explanations/decisions +++ @@ -47,9 +52,13 @@ The documentation is split into 4 sections: .. grid-item-card:: :material-regular:`menu_book;3em` .. toctree:: + :caption: Reference :maxdepth: 1 - + developer/reference/standards + user/reference/migration_guide + user/reference/release_compatibility + ../genindex +++ @@ -65,3 +74,8 @@ PandABlocks-webcontrol https://PandABlocks.github.io/PandABlocks-webcontrol PandABlocks-client https://PandABlocks.github.io/PandABlocks-client ======================= ===================================================== +.. toctree:: + :hidden: + + user/index + developer/index diff --git a/docs/tutorials.rst b/docs/tutorial.rst similarity index 86% rename from docs/tutorials.rst rename to docs/tutorial.rst index 7f490fe..75e4f71 100644 --- a/docs/tutorials.rst +++ b/docs/tutorial.rst @@ -1,4 +1,5 @@ -# Tutorials +Tutorials +========== Tutorials for installation and typical usage. New users start here. diff --git a/docs/tutorials/test.json b/docs/tutorials/test.json new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/tutorials/test.json @@ -0,0 +1 @@ +