Edited the parameter label so that it aligns with standard sphinx par…

…ameter docuemtnation
PrincetonUniversity · Feb 25, 2025 · 4cbf45d · 4cbf45d
1 parent e539946
commit 4cbf45d
Show file tree

Hide file tree

Showing 7 changed files with 189 additions and 189 deletions.
diff --git a/docs/parameter_documentation/databases.rst b/docs/parameter_documentation/databases.rst
@@ -17,19 +17,19 @@ Parameter definitions
 ..dropdown:: ``databases``
     :open:
 
-    **default value** : None
+    :default value: None
 
-    **possible values** : [YAML Node]
+    :possible values: [YAML Node]
 
-    **documentation** : Define databases section
+    :documentation: Define databases section
 
 
     .. _database-file-parameter:
 
     .. dropdown:: ``databases.mesh-database``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [string]
+        :possible values: [string]
 
-        **documentation** : Location of the fortran binary database file defining the mesh
+        :documentation: Location of the fortran binary database file defining the mesh
diff --git a/docs/parameter_documentation/header.rst b/docs/parameter_documentation/header.rst
@@ -22,24 +22,24 @@ Parameter definitions
 .. dropdown:: ``header``
     :open:
 
-    **default value** : None
+    :default value: None
 
-    **possible values** : [YAML Node]
+    :possible values: [YAML Node]
 
-    **documentation** : Define header section
+    :documentation: Define header section
 
     .. dropdown:: ``header.title``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [string]
+        :possible values: [string]
 
-        **documentation** : Brief name for this simulation
+        :documentation: Brief name for this simulation
 
     .. dropdown:: ``header.description``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [string]
+        :possible values: [string]
 
-        **documentation** : Detailed description for this run.
+        :documentation: Detailed description for this run.
diff --git a/docs/parameter_documentation/receivers.rst b/docs/parameter_documentation/receivers.rst
@@ -30,38 +30,38 @@ Parameter definitions
 .. dropdown:: ``receivers``
     :open:
 
-    **default value** : None
+    :default value: None
 
-    **possible values** : [YAML Node]
+    :possible values: [YAML Node]
 
-    **documentation** : receiver information required to calculate seismograms.
+    :documentation: receiver information required to calculate seismograms.
 
 
     .. dropdown:: ``receivers.stations``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [string]
+        :possible values: [string]
 
-        **documentation** : Path to ``stations_file``
+        :documentation: Path to ``stations_file``
 
 
     .. dropdown:: ``receivers.angle``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [float]
+        :possible values: [float]
 
-        **documentation** : Angle to rotate components at receivers
+        :documentation: Angle to rotate components at receivers
 
 
     .. dropdown:: ``receivers.seismogram-type``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [YAML list]
+        :possible values: [YAML list]
 
-        **documentation** : Type of seismograms to be written.
+        :documentation: Type of seismograms to be written.
 
 
 
@@ -93,9 +93,9 @@ Parameter definitions
 
     .. dropdown:: ``receivers.nstep_between_samples``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [int]
+        :possible values: [int]
 
-        **documentation** : Number of time steps between sampling the wavefield
+        :documentation: Number of time steps between sampling the wavefield
                             at station locations for writing seismogram.
diff --git a/docs/parameter_documentation/run_setup.rst b/docs/parameter_documentation/run_setup.rst
@@ -18,25 +18,25 @@ Parameter definitions
 .. dropdown:: ``run-setup``
     :open:
 
-    **default value** : number-of-processors: 1, number-of-runs: 1
+    :default value: number-of-processors: 1, number-of-runs: 1
 
-    **possible values** : [YAML Node]
+    :possible values: [YAML Node]
 
-    **documentation** : Define run-time configuration for your simulation
+    :documentation: Define run-time configuration for your simulation
 
     .. dropdown:: ``run-setup.number-of-processors``
 
-        **default value** : 1
+        :default value: 1
 
-        **possible values** : [int]
+        :possible values: [int]
 
-        **documentation** : Number of MPI processes used in the simulation. MPI version is not enabled in this version of the package. number-of-processors == 1
+        :documentation: Number of MPI processes used in the simulation. MPI version is not enabled in this version of the package. number-of-processors == 1
 
 
     .. dropdown:: ``run-setup.number-of-runs``
 
-        **default value** : 1
+        :default value: 1
 
-        **possible values** : [int]
+        :possible values: [int]
 
-        **documentation** : Number of runs in this simulation. Only single run implemented in this version of the package. number-of-runs == 1
+        :documentation: Number of runs in this simulation. Only single run implemented in this version of the package. number-of-runs == 1
diff --git a/docs/parameter_documentation/seismogram_setup.rst b/docs/parameter_documentation/seismogram_setup.rst
@@ -11,28 +11,28 @@ Parameter definitions
 .. dropdown:: ``seismogram``
     :open:
 
-    **default value** : NULL
+    :default value: NULL
 
-    **possible values** : [YAML Node]
+    :possible values: [YAML Node]
 
-    **documentation** : Define seismogram output configuration
+    :documentation: Define seismogram output configuration
 
 
     .. dropdown:: ``seismogram.seismogram-format``
 
-        **default value** : None
+        :default value: None
 
-        **possible values** : [ascii]
+        :possible values: [ascii]
 
-        **documentation** : Type of seismogram format to be written.
+        :documentation: Type of seismogram format to be written.
 
         1. ascii - :ref:`ASCII` writes calculated seismogram values to seismogram files in string format.
 
 
     .. dropdown:: ``seismogram.output-folder``
 
-        **default value** : Current working directory
+        :default value: Current working directory
 
-        **possible values** : [string]
+        :possible values: [string]
 
-        **documentation** : Path to output folder where the seismograms will be saved.
+        :documentation: Path to output folder where the seismograms will be saved.