diff --git a/docs/source/_defaults.inc b/docs/source/_defaults.inc index df9c0fd53..3872ccbae 100644 --- a/docs/source/_defaults.inc +++ b/docs/source/_defaults.inc @@ -1,4 +1,4 @@ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -16,7 +16,7 @@ | verbose | ``1.0`` | verbosity | +----------------------------------+------------------+----------------------------------------------------+ -* section: [io] +* section: ``[io]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -33,7 +33,7 @@ | | | simulation ends? | +----------------------------------+------------------+----------------------------------------------------+ -* section: [mesh] +* section: ``[mesh]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -62,7 +62,7 @@ | ny | ``25`` | number of zones in the y-direction | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -74,7 +74,7 @@ | particle_generator | ``random`` | how do we generate particles? (random, grid) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [vis] +* section: ``[vis]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/advection_defaults.inc b/docs/source/advection_defaults.inc index 470ac8572..a3b795d5a 100644 --- a/docs/source/advection_defaults.inc +++ b/docs/source/advection_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -10,7 +10,7 @@ | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -18,7 +18,7 @@ | cfl | ``0.8`` | advective CFL number | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/advection_fv4_defaults.inc b/docs/source/advection_fv4_defaults.inc index 9194f2570..94e8f073d 100644 --- a/docs/source/advection_fv4_defaults.inc +++ b/docs/source/advection_fv4_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -12,7 +12,7 @@ | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/advection_nonuniform_defaults.inc b/docs/source/advection_nonuniform_defaults.inc index 470ac8572..a3b795d5a 100644 --- a/docs/source/advection_nonuniform_defaults.inc +++ b/docs/source/advection_nonuniform_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -10,7 +10,7 @@ | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -18,7 +18,7 @@ | cfl | ``0.8`` | advective CFL number | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/advection_rk_defaults.inc b/docs/source/advection_rk_defaults.inc index 2aed8a7b5..4441dda77 100644 --- a/docs/source/advection_rk_defaults.inc +++ b/docs/source/advection_rk_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -12,7 +12,7 @@ | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/advection_weno_defaults.inc b/docs/source/advection_weno_defaults.inc index 71351d5e8..f14b8080d 100644 --- a/docs/source/advection_weno_defaults.inc +++ b/docs/source/advection_weno_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -15,7 +15,7 @@ | temporal_method | ``RK4`` | integration method (see mesh/integrators.py) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/burgers_defaults.inc b/docs/source/burgers_defaults.inc index 0f1470006..3e6e8546e 100644 --- a/docs/source/burgers_defaults.inc +++ b/docs/source/burgers_defaults.inc @@ -1,4 +1,4 @@ -* section: [advection] +* section: ``[advection]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | limiter | ``2`` | limiter (0 = none, 1 = 2nd order, 2 = 4th order) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -14,7 +14,7 @@ | cfl | ``0.8`` | advective CFL number | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/compressible_defaults.inc b/docs/source/compressible_defaults.inc index 3ca441d1f..4505e8867 100644 --- a/docs/source/compressible_defaults.inc +++ b/docs/source/compressible_defaults.inc @@ -1,4 +1,4 @@ -* section: [compressible] +* section: ``[compressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -20,7 +20,7 @@ | riemann | ``HLLC`` | HLLC or CGF | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -28,7 +28,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -36,7 +36,7 @@ | gamma | ``1.4`` | pres = rho ener (gamma - 1) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/compressible_fv4_defaults.inc b/docs/source/compressible_fv4_defaults.inc index 51e71c152..7e02623d8 100644 --- a/docs/source/compressible_fv4_defaults.inc +++ b/docs/source/compressible_fv4_defaults.inc @@ -1,4 +1,4 @@ -* section: [compressible] +* section: ``[compressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -22,7 +22,7 @@ | riemann | ``CGF`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -30,7 +30,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/compressible_react_defaults.inc b/docs/source/compressible_react_defaults.inc index a4b80e9e1..7944192e6 100644 --- a/docs/source/compressible_react_defaults.inc +++ b/docs/source/compressible_react_defaults.inc @@ -1,4 +1,4 @@ -* section: [compressible] +* section: ``[compressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -22,7 +22,7 @@ | riemann | ``HLLC`` | HLLC or CGF | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -30,7 +30,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/compressible_rk_defaults.inc b/docs/source/compressible_rk_defaults.inc index 36c00d3ce..63f1a1c56 100644 --- a/docs/source/compressible_rk_defaults.inc +++ b/docs/source/compressible_rk_defaults.inc @@ -1,4 +1,4 @@ -* section: [compressible] +* section: ``[compressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -25,7 +25,7 @@ | | | hydrostatic equilibrium | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -33,7 +33,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/compressible_sdc_defaults.inc b/docs/source/compressible_sdc_defaults.inc index 51e71c152..7e02623d8 100644 --- a/docs/source/compressible_sdc_defaults.inc +++ b/docs/source/compressible_sdc_defaults.inc @@ -1,4 +1,4 @@ -* section: [compressible] +* section: ``[compressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -22,7 +22,7 @@ | riemann | ``CGF`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -30,7 +30,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/diffusion_defaults.inc b/docs/source/diffusion_defaults.inc index ae2959b5f..baf3e5115 100644 --- a/docs/source/diffusion_defaults.inc +++ b/docs/source/diffusion_defaults.inc @@ -1,4 +1,4 @@ -* section: [diffusion] +* section: ``[diffusion]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | k | ``1.0`` | conductivity | +----------------------------------+------------------+----------------------------------------------------+ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/incompressible_defaults.inc b/docs/source/incompressible_defaults.inc index 913eef731..bccf05d1d 100644 --- a/docs/source/incompressible_defaults.inc +++ b/docs/source/incompressible_defaults.inc @@ -1,4 +1,4 @@ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [incompressible] +* section: ``[incompressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -16,7 +16,7 @@ | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/incompressible_viscous_defaults.inc b/docs/source/incompressible_viscous_defaults.inc index c53977109..f2851ffa6 100644 --- a/docs/source/incompressible_viscous_defaults.inc +++ b/docs/source/incompressible_viscous_defaults.inc @@ -1,4 +1,4 @@ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [incompressible] +* section: ``[incompressible]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -16,7 +16,7 @@ | proj_type | ``2`` | what are we projecting? 1 includes -Gp term in U* | +----------------------------------+------------------+----------------------------------------------------+ -* section: [incompressible_viscous] +* section: ``[incompressible_viscous]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -24,7 +24,7 @@ | viscosity | ``0.1`` | kinematic viscosity of the fluid (units L^2/T) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/lm_atm_defaults.inc b/docs/source/lm_atm_defaults.inc index f06c0809c..2b57c4dc2 100644 --- a/docs/source/lm_atm_defaults.inc +++ b/docs/source/lm_atm_defaults.inc @@ -1,4 +1,4 @@ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [eos] +* section: ``[eos]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -14,7 +14,7 @@ | gamma | ``1.4`` | pres = rho ener (gamma - 1) | +----------------------------------+------------------+----------------------------------------------------+ -* section: [lm-atmosphere] +* section: ``[lm-atmosphere]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/docs/source/swe_defaults.inc b/docs/source/swe_defaults.inc index 3bfcf39a4..10a12137a 100644 --- a/docs/source/swe_defaults.inc +++ b/docs/source/swe_defaults.inc @@ -1,4 +1,4 @@ -* section: [driver] +* section: ``[driver]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -6,7 +6,7 @@ | cfl | ``0.8`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [particles] +* section: ``[particles]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | @@ -16,7 +16,7 @@ | particle_generator | ``grid`` | | +----------------------------------+------------------+----------------------------------------------------+ -* section: [swe] +* section: ``[swe]`` +----------------------------------+------------------+----------------------------------------------------+ | option | value | description | diff --git a/pyro/util/runparams.py b/pyro/util/runparams.py index 6946912b7..53023d693 100644 --- a/pyro/util/runparams.py +++ b/pyro/util/runparams.py @@ -296,7 +296,7 @@ def print_sphinx_tables(self, outfile="params-sphinx.inc"): for sec in sorted(secs): keys = [q for q in all_keys if q.startswith(f"{sec}.")] - head = f"* section: [{sec.strip()}]" + head = f"* section: ``[{sec.strip()}]``" f.write(f"{head}\n\n") #f.write(len(head)*"^"+"\n\n")