ESMValGroup · ehogan · Jun 26, 2024 · Jun 25, 2024 · Jun 25, 2024 · Jun 25, 2024
diff --git a/.github/workflows/check-rtw.yml b/.github/workflows/check-rtw.yml
@@ -1,5 +1,5 @@
 # This workflow performs various validation steps for Cylc and Rose, and
-# builds and checks the documentation.
+# checks the documentation.
 name: Check Recipe Test Workflow (RTW)
 
 # Controls when the action will run
@@ -68,14 +68,9 @@ jobs:
           cd esmvaltool/utils/recipe_test_workflow/recipe_test_workflow
           rose macro -V
 
-      - name: Build documentation
-        run: |
-          cd esmvaltool/utils/recipe_test_workflow/doc
-          make html
-
       - name: Check for broken links in the documentation
         run: |
-          cd esmvaltool/utils/recipe_test_workflow/doc
+          cd doc/sphinx/source/utils/RTW/
           make linkcheck
 
       - name: Lint shell scripts

diff --git a/doc/sphinx/source/gensidebar.py b/doc/sphinx/source/gensidebar.py
@@ -65,7 +65,7 @@ def _header(project, text):
     _write("esmvaltool", "Obtaining input data", "input")
     _write("esmvaltool", "Making a recipe or diagnostic", "develop/index")
     _write("esmvaltool", "Contributing to the community", "community/index")
-    _write("esmvaltool", "Utilities", "utils")
+    _write("esmvaltool", "Utilities", "utils/utils")
     _write("esmvaltool", "Diagnostics API Reference", "api/esmvaltool")
     _write("esmvaltool", "Frequently Asked Questions", "faq")
     _write("esmvaltool", "Changelog", "changelog")

diff --git a/...recipe_test_workflow/doc/source/about.rst → doc/sphinx/source/utils/RTW/about.rst b/...recipe_test_workflow/doc/source/about.rst → doc/sphinx/source/utils/RTW/about.rst
diff --git a/...test_workflow/doc/source/add_a_recipe.rst → doc/sphinx/source/utils/RTW/add_a_recipe.rst b/...test_workflow/doc/source/add_a_recipe.rst → doc/sphinx/source/utils/RTW/add_a_recipe.rst
diff --git a/...ecipe_test_workflow/doc/source/common.txt → doc/sphinx/source/utils/RTW/common.txt b/...ecipe_test_workflow/doc/source/common.txt → doc/sphinx/source/utils/RTW/common.txt
diff --git a/...ipe_test_workflow/doc/source/glossary.rst → doc/sphinx/source/utils/RTW/glossary.rst b/...ipe_test_workflow/doc/source/glossary.rst → doc/sphinx/source/utils/RTW/glossary.rst
diff --git a/doc/sphinx/source/utils/RTW/index.rst b/doc/sphinx/source/utils/RTW/index.rst
@@ -0,0 +1,11 @@
+Recipe Test Workflow (RTW)
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   about
+   tested_recipes
+   user_guide/index
+   add_a_recipe
+   glossary
diff --git a/...st_workflow/doc/source/tested_recipes.rst → ...phinx/source/utils/RTW/tested_recipes.rst b/...st_workflow/doc/source/tested_recipes.rst → ...phinx/source/utils/RTW/tested_recipes.rst
diff --git a/..._workflow/doc/source/user_guide/index.rst → ...inx/source/utils/RTW/user_guide/index.rst b/..._workflow/doc/source/user_guide/index.rst → ...inx/source/utils/RTW/user_guide/index.rst
diff --git a/...low/doc/source/user_guide/quick_start.rst → ...urce/utils/RTW/user_guide/quick_start.rst b/...low/doc/source/user_guide/quick_start.rst → ...urce/utils/RTW/user_guide/quick_start.rst
diff --git a/...rkflow/doc/source/user_guide/workflow.rst → .../source/utils/RTW/user_guide/workflow.rst b/...rkflow/doc/source/user_guide/workflow.rst → .../source/utils/RTW/user_guide/workflow.rst
diff --git a/doc/sphinx/source/utils.rst → doc/sphinx/source/utils/utils.rst b/doc/sphinx/source/utils.rst → doc/sphinx/source/utils/utils.rst
@@ -517,3 +517,11 @@ The tool is based on the `prov <https://prov.readthedocs.io/en/latest/readme.htm
 library, a useful library for working with provenance files.
 With minor adaptations, this script could also print out global attributes
 of the input NetCDF files, e.g. the tracking_id.
+
+Recipe Test Workflow (RTW)
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   RTW/index
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/Makefile b/esmvaltool/utils/recipe_test_workflow/doc/Makefile
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/make.bat b/esmvaltool/utils/recipe_test_workflow/doc/make.bat
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/_static/README b/esmvaltool/utils/recipe_test_workflow/doc/source/_static/README
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/_templates/footer.html b/esmvaltool/utils/recipe_test_workflow/doc/source/_templates/footer.html
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/conf.py b/esmvaltool/utils/recipe_test_workflow/doc/source/conf.py
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/index.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/index.rst