Merge pull request #389 from xylar/fix_docstrings_and_docs

Many fixes to the documentation
MPAS-Dev · May 13, 2022 · c8f1b60 · c8f1b60
2 parents 67e8b48 + af4205c
commit c8f1b60
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 9 deletions.
diff --git a/docs/developers_guide/landice/api.rst b/docs/developers_guide/landice/api.rst
@@ -237,7 +237,7 @@ kangerlussuaq
 .. currentmodule:: compass.landice.tests.kangerlussuaq
 
 .. autosummary::
-   :toctrr: generate/
+   :toctree: generated/
 
    Kangerlussuaq
 
@@ -250,10 +250,10 @@ kangerlussuaq
 koge_bugt_s
 ~~~~~~~~~~~
 
-.. currentmodule:: compass.landice.tests.boge_bugt_s
+.. currentmodule:: compass.landice.tests.koge_bugt_s
 
 .. autosummary::
-      :toctrr: generate/
+   :toctree: generated/
 
    KogeBugtS
 

diff --git a/docs/developers_guide/landice/test_groups/kangerlussuaq.rst b/docs/developers_guide/landice/test_groups/kangerlussuaq.rst
@@ -1,7 +1,7 @@
 .. _dev_landice_kangerlussuaq:
 
 kangerlussuaq
-========
+=============
 
 The ``kangerlussuaq`` test group (:py:class:`compass.landice.tests.kangerlussuaq.Kangerlussuaq`)
 creates a variable resolution (default 1-10 km) mesh for a regional domain of Kangerlussuaq Glacier

diff --git a/docs/developers_guide/landice/test_groups/koge_bugt_s.rst b/docs/developers_guide/landice/test_groups/koge_bugt_s.rst
@@ -1,7 +1,7 @@
 .. _dev_landice_koge_bugt_s:
 
 koge_bugt_s
-========
+===========
 
 The ``koge_bugt_s`` test group (:py:class:`compass.landice.tests.koge_bugt_s.KogeBugtS`)
 creates a variable resolution (default 500m to 4km) mesh for a regional domain of Koge Bugt S, Greenland

diff --git a/docs/users_guide/landice/test_groups/kangerlussuaq.rst b/docs/users_guide/landice/test_groups/kangerlussuaq.rst
@@ -1,7 +1,7 @@
 .. _landice_kangerlussuaq:
 
 kangerlussuaq
-========
+=============
 
 The ``landice/kangerlussuaq`` test group includes a test case for creating a
 mesh for Kangerlussuaq Glacier, Greenland. The optimization for basal friction
@@ -47,7 +47,7 @@ the mesh generation options are adjusted through the config file.
     high_dist = 1.e5
     # distance within which cell spacing = min_spac (meters)
     low_dist = 1.e4
-    
+
     # mesh density functions
     use_speed = True
     use_dist_to_grounding_line = False

diff --git a/docs/users_guide/landice/test_groups/koge_bugt_s.rst b/docs/users_guide/landice/test_groups/koge_bugt_s.rst
@@ -1,7 +1,7 @@
 .. _landice_koge_bugt_s:
 
 koge_bugt_s
-========
+===========
 
 The ``landice/koge_bugt_s`` test group includes a test case for creating a
 mesh for Koge Bugt S, Greenland. The optimization for basal friction
@@ -47,7 +47,7 @@ the mesh generation options are adjusted through the config file.
     high_dist = 1.e5
     # distance within which cell spacing = min_spac (meters)
     low_dist = 1.e4
-    
+
     # mesh density functions
     use_speed = True
     use_dist_to_grounding_line = False

diff --git a/docs/users_guide/quick_start.rst b/docs/users_guide/quick_start.rst
@@ -348,6 +348,7 @@ or the number of nodes (scaled according to the number of cores require by the
 test cases by default).
 
 .. code-block:: bash
+
     #!/bin/bash
     #SBATCH  --job-name=compass
     #SBATCH  --account=condo
@@ -367,6 +368,7 @@ You can also use config options, passed to ``compass suite`` or
 The following are the config options that are relevant to job scripts:
 
 .. code-block:: cfg
+
     # The parallel section describes options related to running jobs in parallel
     [parallel]