From 37caf2c2064589bae91ac7d3ca514bd2be5046ba Mon Sep 17 00:00:00 2001 From: Tomas Lovato <tomas.lovato@cmcc.it> Date: Thu, 23 Feb 2023 12:33:02 +0100 Subject: [PATCH] fix cross references within the user guide --- source/cfgs.rst | 4 ++-- source/install.rst | 4 +--- source/setup.rst | 2 +- source/todos.rst | 5 ----- 4 files changed, 4 insertions(+), 11 deletions(-) delete mode 100644 source/todos.rst diff --git a/source/cfgs.rst b/source/cfgs.rst index 62d216d..57cbc0a 100644 --- a/source/cfgs.rst +++ b/source/cfgs.rst @@ -159,7 +159,7 @@ Analytical forcing for heat, freshwater and wind-stress fields are applied. This configuration acts also as demonstrator of the **user defined setup** (``ln_read_cfg = .false.``) and grid setting are handled through -the ``&namusr_def`` controls in :file:`namelist.cfg, lines 35-41 : <https://forge.nemo-ocean.eu/nemo/nemo/-/tree/4.2.0/cfgs/GYRE_PISCES/EXPREF/namelist_cfg>`_ +the ``&namusr_def`` controls in :coderepo:`namelist.cfg, lines 35-41 : </cfgs/GYRE_PISCES/EXPREF/namelist_cfg>` Note that, the default grid size is 30x20 grid points (with ``nn_GYRE = 1``) and @@ -246,7 +246,7 @@ ORCA2_OFF_PISCES | This enables for an offline coupling of TOP components. Pre-calculated dynamical fields are provided to NEMO using -the namelist ``&namdta_dyn`` in :file:`namelist_cfg <https://forge.nemo-ocean.eu/nemo/nemo/-/blob/4.2.0/cfgs/ORCA2_OFF_PISCES/EXPREF/namelist_cfg>`_, +the namelist ``&namdta_dyn`` in :coderepo:`namelist_cfg </cfgs/ORCA2_OFF_PISCES/EXPREF/namelist_cfg>`, in this case with a 5 days frequency (120 hours): diff --git a/source/install.rst b/source/install.rst index bb7fd6f..964c0df 100644 --- a/source/install.rst +++ b/source/install.rst @@ -153,14 +153,12 @@ Description of 1\ :sup:`st` level tree structure +---------------+-------------------------------------------------+ | :file:`cfgs` | :doc:`Reference configurations <cfgs>` | +---------------+-------------------------------------------------+ -| :file:`doc` | :doc:`Documentation <doc>` | -+---------------+-------------------------------------------------+ | :file:`ext` | Dependencies included | | | (``AGRIF``, ``FCM``, ``PPR`` & ``IOIPSL``) | +---------------+-------------------------------------------------+ | :file:`mk` | Compilation scripts | +---------------+-------------------------------------------------+ -| :file:`src` | :doc:`NEMO codebase <src>` | +| :file:`src` | NEMO codebase | +---------------+-------------------------------------------------+ | :file:`tests` | :doc:`Test cases <tests>` | | | (unsupported) | diff --git a/source/setup.rst b/source/setup.rst index 56a64a6..3877056 100644 --- a/source/setup.rst +++ b/source/setup.rst @@ -148,7 +148,7 @@ There are two options for creating a :file:`domain_cfg.nc` file: - Users can adapt and apply the supplied tool available in :file:`./tools/DOMAINcfg`. This tool is based on code extracted from NEMO version 3.6 and will allow similar choices for the horizontal and vertical grids that were available internally to that version. - See :ref:`tools <DOMAINcfg>` for details. + See :doc:`DOMAINcfg tool <tools>` for details. Option 2: Adapt the usr_def configuration module of NEMO for you own purposes ----------------------------------------------------------------------------- diff --git a/source/todos.rst b/source/todos.rst deleted file mode 100644 index 1ac4948..0000000 --- a/source/todos.rst +++ /dev/null @@ -1,5 +0,0 @@ -********************* -List of editing tasks -********************* - -.. todolist:: -- GitLab