Commit 84c814d6 authored by Lukas Riedel's avatar Lukas Riedel 📝

Use title case for parameter file doc headings

Increase contents tree depth.

[skip ci]
parent 69a60efb
...@@ -10,7 +10,7 @@ retrieving this information, depending on the type of grid used for the ...@@ -10,7 +10,7 @@ retrieving this information, depending on the type of grid used for the
computation. computation.
.. contents:: .. contents::
:depth: 2 :depth: 3
:local: :local:
A YAML_ parameter file is always required. It specifies a set of A YAML_ parameter file is always required. It specifies a set of
...@@ -268,7 +268,7 @@ Constant ...@@ -268,7 +268,7 @@ Constant
hydrodynamic_disp_zy: hydrodynamic_disp_zy:
hydrodynamic_disp_zz: hydrodynamic_disp_zz:
Power law Power Law
""""""""" """""""""
Implements the following parameterization function: Implements the following parameterization function:
...@@ -318,10 +318,10 @@ Superposition ...@@ -318,10 +318,10 @@ Superposition
Each of the types are further parameterized and can be found below. Each of the types are further parameterized and can be found below.
Effective diffusion Effective Diffusion
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Constant effective diffusion Constant Effective Diffusion
############################ ############################
In this case, the effective diffusion is inserted directly, In this case, the effective diffusion is inserted directly,
...@@ -349,7 +349,7 @@ Constant effective diffusion ...@@ -349,7 +349,7 @@ Constant effective diffusion
eff_diff: eff_diff:
# <Dhm_type> parameters ... # <Dhm_type> parameters ...
Milligton-Quirk I effective diffusion Milligton-Quirk I Effective Diffusion
##################################### #####################################
Implements the following parameterization function: Implements the following parameterization function:
...@@ -380,8 +380,8 @@ Milligton-Quirk I effective diffusion ...@@ -380,8 +380,8 @@ Milligton-Quirk I effective diffusion
phi: phi:
# <Dhm_type> parameters ... # <Dhm_type> parameters ...
Milligton-Quirk I effective diffusion Milligton-Quirk II Effective Diffusion
##################################### ######################################
Implements the following parameterization function: Implements the following parameterization function:
...@@ -411,10 +411,10 @@ Milligton-Quirk I effective diffusion ...@@ -411,10 +411,10 @@ Milligton-Quirk I effective diffusion
phi: phi:
# <Dhm_type> parameters ... # <Dhm_type> parameters ...
Effective hydromechanic dispersion Effective Hydromechanic Dispersion
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Constant effective hydromechanic dispersion tensor Constant Effective Hydromechanic Dispersion Tensor
################################################## ##################################################
In this case, the effective hydromechanic dispersion tensor is inserted In this case, the effective hydromechanic dispersion tensor is inserted
...@@ -460,7 +460,7 @@ Constant effective hydromechanic dispersion tensor ...@@ -460,7 +460,7 @@ Constant effective hydromechanic dispersion tensor
# <Deff_type> parameters ... # <Deff_type> parameters ...
Effective hydromechanic dispersion tensor for isotropic media Effective Hydromechanic Dispersion Tensor for Isotropic Media
############################################################# #############################################################
Implements the following parameterization function: Implements the following parameterization function:
...@@ -518,7 +518,7 @@ coordinates in the respective spatial dimensions. ...@@ -518,7 +518,7 @@ coordinates in the respective spatial dimensions.
omitted. Only omitting the respective *values* of both keys will lead to omitted. Only omitting the respective *values* of both keys will lead to
a parser error. a parser error.
Miller scaling Miller Scaling
"""""""""""""" """"""""""""""
Assumes geometric similarity between scaled regions. Applies the following Assumes geometric similarity between scaled regions. Applies the following
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment