From c3902e4f8f7ba7f4a652410f0036a2d3100f8b88 Mon Sep 17 00:00:00 2001 From: Ed Gillett <146008263+mo-gill@users.noreply.github.com> Date: Wed, 29 May 2024 14:36:23 +0100 Subject: [PATCH] :3074: Improve formatting. --- .../doc/source/user_guide/adding_a_recipe.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst index ffeb511b97..ce12974dbc 100644 --- a/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst +++ b/esmvaltool/utils/recipe_test_workflow/doc/source/user_guide/adding_a_recipe.rst @@ -12,11 +12,12 @@ site specific ``.cylc`` file in the site directory). cylc stop "a_running_recipe_test_workflow" -#. Locate your local .cylc file, found in (recipe_test_workflow/site). +#. Locate your local ``.cylc`` file, found in (recipe_test_workflow/site) + . #. Open it in your preferred code editor. -#. Locate the `COMPUTE` section, it should look something like this:: +#. Locate the ``[[COMPUTE]]`` section, it should look something like this:: [[COMPUTE]] platform = @@ -34,7 +35,7 @@ site specific ``.cylc`` file in the site directory). ". #. If either of the memory readings from your run are larger than the - values specified in the `COMPUTE` section, you need to add your recipe as + values specified in the ``[[COMPUTE]]`` section, you need to add your recipe as another `process` similar to:: [[process]] @@ -52,7 +53,7 @@ site specific ``.cylc`` file in the site directory). #. Copy the output files from the "cycle" folder (``run/share/cycle``) of the workflow you just ran, to your site specific KGO rootpath folder - (this folder should be set as the value for the variable "KGO_ROOT_PATH=" + (this folder should be set as the value for the variable ``KGO_ROOT_PATH=`` in your ``rose-suite.conf`` file found in the ``/data/users/esmva l/KGO`` directory):: @@ -77,8 +78,8 @@ site specific ``.cylc`` file in the site directory). #. The workflow should now succeed. -#. Add your recipe to the list of "Currently tested recipes" in ``tested_recipe - s.rst`` (this file is located within ``recipe_test_workflow/doc/source``) in +#. Add your recipe to the list of "Currently tested recipes" in ``tested_recipes.rst`` + (this file is located within ``recipe_test_workflow/doc/source``) in it's correct position (the list is ordered alphabetically), this will add it to the documentation.