Play with the ref settings for config files

Signed-off-by: Lizzie Lundgren <elundgren@seas.harvard.edu>
geoschem · Jun 21, 2022 · 5ade8ce · 5ade8ce
1 parent 19f4dc8
commit 5ade8ce
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/source/user-guide/rundir-config.rst b/docs/source/user-guide/rundir-config.rst
@@ -18,7 +18,8 @@ This section gives an overview of all run directory configuration files used at
 .. toctree::
    :maxdepth: 1
 
-   config-files/GCHP_rc.rst
+   :ref:`setCommonRunSetting.sh <_setCommonRunSettings_sh>`
+   :ref:`GCHP.rc <_GCHP_rc>`
    config-files/CAP_rc.rst
    config-files/ExtData_rc.rst
    config-files/geoschem_config_yml.rst
@@ -28,15 +29,16 @@ This section gives an overview of all run directory configuration files used at
    config-files/HISTORY_rc.rst
    config-files/HEMCO_Diagn_rc.rst
 
-The run directory also includes bash script :file:`setCommonRunningSetting.sh` to edit commonly changed run-time settings from one place, making the run configuration process for GCHP more manageable..
+The run directory also includes bash script :file:`setCommonRunningSetting.sh` to edit commonly changed run-time settings from one place, making the run configuration process for GCHP more manageable.
 
-setCommonRunSettings.sh
-^^^^^^^^^^^^^^^^^^^^^^^
 
-This file is actually a bash script that includes commonly changed run settings. It makes it easier to manage configuring GCHP since settings can be changed from one file rather than across multiple configuration files. When this file is executed it updates settings in other configuration files, overwriting what is there. Please get very familiar with the options in :file:`setCommonRunSettings.sh` and be conscientious about not updating the same setting elsewhere.
+.. _setcommonrunsettings_sh:
 
-Other configuration files
-^^^^^^^^^^^^^^^^^^^^^^^^^
+:file:`setCommonRunSettings.sh`
+
+This file is a bash script that includes commonly changed run settings. It makes it easier to manage configuring GCHP since settings can be changed from one file rather than across multiple configuration files. When this file is executed it updates settings in other configuration files, overwriting what is there. Please get very familiar with the options in :file:`setCommonRunSettings.sh` and be conscientious about not updating the same setting elsewhere.
+
+.. _GCHP_rc:
 
 :file:`GCHP.rc`
    Controls high-level aspects of the simulation, including grid type and resolution, core distribution, stretched-grid parameters, timesteps, and restart filename.

diff --git a/docs/source/user-guide/running.rst b/docs/source/user-guide/running.rst
@@ -68,7 +68,7 @@ You may copy and adapt this file for your system and preferences as needed.
 At the top of all batch job scripts are configurable run settings. 
 Most critically are requested # cores, # nodes, time, and memory. 
 Figuring out the optimal values for your run can take some trial and error. 
-See :ref:`hardware requirements <hardware_requirements.>` for guidance on what to choose. 
+See :ref:`hardware requirements <hardware_requirements>` for guidance on what to choose. 
 The more cores you request the faster GCHP will run given the same grid resolution. 
 Configurable job scheduler settings and acceptable formats are often accessible from the command line. 
 For example, type :command:`man sbatch` to scroll through configurable options for SLURM, including various ways of specifying number of cores, time and memory requested.