From 5666b3aefede1bac90cb528ace497c861e975926 Mon Sep 17 00:00:00 2001
From: Hu Zhao <zhao@mbd.rwth-aachen.de>
Date: Tue, 6 Dec 2022 17:52:44 +0100
Subject: [PATCH] docs: adjust punctuation characters for section headers

---
 docs/source/index.rst                       |  2 +-
 docs/source/inference/active_learning.rst   |  6 +++---
 docs/source/inference/bayes_inference.rst   | 10 +++++-----
 docs/source/inference/index.rst             |  3 ++-
 docs/source/sampler/index.rst               |  3 ++-
 docs/source/sampler/latin.rst               |  6 +++---
 docs/source/sampler/metropolis_hastings.rst |  6 +++---
 docs/source/sampler/saltelli.rst            |  6 +++---
 docs/source/sensitivity/index.rst           |  3 ++-
 docs/source/sensitivity/sobol.rst           |  6 +++---
 docs/source/simulator/index.rst             |  3 ++-
 docs/source/simulator/mass_point_model.rst  |  6 +++---
 docs/source/simulator/ravaflow24.rst        |  6 +++---
 docs/source/simulator/run_simulator.rst     |  8 ++++----
 14 files changed, 39 insertions(+), 35 deletions(-)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 85b2b89..c9303db 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,6 +1,5 @@
 :gitlab_url: https://git-ce.rwth-aachen.de/mbd/psimpy
 
-=======
 Welcome
 =======
 
@@ -101,4 +100,5 @@ use :py:mod:`PSimPy`.
    /sampler/index
    /sensitivity/index
    /simulator/index
+   changelog.rst
    refs.rst
diff --git a/docs/source/inference/active_learning.rst b/docs/source/inference/active_learning.rst
index 2cf9707..d2de274 100644
--- a/docs/source/inference/active_learning.rst
+++ b/docs/source/inference/active_learning.rst
@@ -1,14 +1,14 @@
 Active Learning
----------------
+===============
 
 ActiveLearning Class
-^^^^^^^^^^^^^^^^^^^^
+--------------------
 
 The :class:`.ActiveLearning` class is imported by::
     
     from psimpy.inference.active_learning import ActiveLearning
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.inference.active_learning.ActiveLearning
     :members: initial_simulation, iterative_emulation, approx_ln_pxl
\ No newline at end of file
diff --git a/docs/source/inference/bayes_inference.rst b/docs/source/inference/bayes_inference.rst
index f945d0b..9ccb488 100644
--- a/docs/source/inference/bayes_inference.rst
+++ b/docs/source/inference/bayes_inference.rst
@@ -1,27 +1,27 @@
 Bayes Inference
----------------
+===============
 
 GridEstimation Class
-^^^^^^^^^^^^^^^^^^^^
+--------------------
 
 The :class:`.GridEstimation` class is imported by::
     
     from psimpy.inference.bayes_inference import GridEstimation
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.inference.bayes_inference.GridEstimation
     :members: run
 
 
 MetropolisHastingsEstimation Class
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------------
 
 The :class:`.MetropolisHastingsEstimation` class is imported by::
     
     from psimpy.inference.bayes_inference import MetropolisHastingsEstimation
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.inference.bayes_inference.MetropolisHastingsEstimation
     :members: run
diff --git a/docs/source/inference/index.rst b/docs/source/inference/index.rst
index 5ddca83..092e1cf 100644
--- a/docs/source/inference/index.rst
+++ b/docs/source/inference/index.rst
@@ -1,5 +1,6 @@
+*********
 Inference
-=========
+*********
 
 This module hosts functionality for inference methods.
 
diff --git a/docs/source/sampler/index.rst b/docs/source/sampler/index.rst
index 35914fd..25e9f3e 100644
--- a/docs/source/sampler/index.rst
+++ b/docs/source/sampler/index.rst
@@ -1,5 +1,6 @@
+*******
 Sampler
-=======
+*******
 
 This module hosts functionality for sampling methods.
 
diff --git a/docs/source/sampler/latin.rst b/docs/source/sampler/latin.rst
index d7dd64d..060f9d6 100644
--- a/docs/source/sampler/latin.rst
+++ b/docs/source/sampler/latin.rst
@@ -1,14 +1,14 @@
 Latin Hypercube Sampling
-------------------------
+========================
 
 LHS Class
-^^^^^^^^^
+---------
 
 The :class:`.LHS` class is imported by::
     
     from psimpy.sampler.latin import LHS
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.sampler.latin.LHS
     :members: sample
\ No newline at end of file
diff --git a/docs/source/sampler/metropolis_hastings.rst b/docs/source/sampler/metropolis_hastings.rst
index 7b6df1c..6b2c868 100644
--- a/docs/source/sampler/metropolis_hastings.rst
+++ b/docs/source/sampler/metropolis_hastings.rst
@@ -1,14 +1,14 @@
 Metropolis Hastings Sampling
-----------------------------
+============================
 
 MetropolisHastings Class
-^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------
 
 The :class:`.MetropolisHastings` class is imported by::
     
     from psimpy.sampler.metropolis_hastings import MetropolisHastings
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.sampler.metropolis_hastings.MetropolisHastings
     :members: sample
\ No newline at end of file
diff --git a/docs/source/sampler/saltelli.rst b/docs/source/sampler/saltelli.rst
index 1010be6..0b7b340 100644
--- a/docs/source/sampler/saltelli.rst
+++ b/docs/source/sampler/saltelli.rst
@@ -1,14 +1,14 @@
 Saltelli Sampling
------------------
+=================
 
 Saltelli Class
-^^^^^^^^^^^^^^
+--------------
 
 The :class:`.Saltelli` class is imported by::
     
     from psimpy.sampler.saltelli import Saltelli
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.sampler.saltelli.Saltelli
     :members: sample
\ No newline at end of file
diff --git a/docs/source/sensitivity/index.rst b/docs/source/sensitivity/index.rst
index a93a04d..5e60a0a 100644
--- a/docs/source/sensitivity/index.rst
+++ b/docs/source/sensitivity/index.rst
@@ -1,5 +1,6 @@
+***********
 Sensitivity
-===========
+***********
 
 This module hosts functionality for methods of sensitivity analysis.
 
diff --git a/docs/source/sensitivity/sobol.rst b/docs/source/sensitivity/sobol.rst
index 6eee633..7c59f92 100644
--- a/docs/source/sensitivity/sobol.rst
+++ b/docs/source/sensitivity/sobol.rst
@@ -1,14 +1,14 @@
 Sobol' Sensitivity Analyze
---------------------------
+==========================
 
 SobolAnalyze Class
-^^^^^^^^^^^^^^^^^^
+------------------
 
 The :class:`.SobolAnalyze` class is imported by::
     
     from psimpy.sensitivity.sobol import SobolAnalyze
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.sensitivity.sobol.SobolAnalyze
     :members: run
\ No newline at end of file
diff --git a/docs/source/simulator/index.rst b/docs/source/simulator/index.rst
index 08f5572..3021216 100644
--- a/docs/source/simulator/index.rst
+++ b/docs/source/simulator/index.rst
@@ -1,5 +1,6 @@
+*********
 Simulator
-=========
+*********
 
 This module hosts functionality for running simulators, as well as some
 simulators used in the landslide community.
diff --git a/docs/source/simulator/mass_point_model.rst b/docs/source/simulator/mass_point_model.rst
index 33a2839..c21845a 100644
--- a/docs/source/simulator/mass_point_model.rst
+++ b/docs/source/simulator/mass_point_model.rst
@@ -1,14 +1,14 @@
 Mass Point Model
-----------------
+================
 
 MassPointModel Class
-^^^^^^^^^^^^^^^^^^^^
+--------------------
 
 The :class:`.MassPointModel` class is imported by::
     
     from psimpy.simulator.mass_point_model import MassPointModel
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.simulator.mass_point_model.MassPointModel
     :members: run
\ No newline at end of file
diff --git a/docs/source/simulator/ravaflow24.rst b/docs/source/simulator/ravaflow24.rst
index 5f52ec2..35fd786 100644
--- a/docs/source/simulator/ravaflow24.rst
+++ b/docs/source/simulator/ravaflow24.rst
@@ -1,14 +1,14 @@
 Ravaflow24 Mixture Model
-------------------------
+========================
 
 Ravaflow24Mixture Class
-^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------
 
 The :class:`.Ravaflow24Mixture` class is imported by::
     
     from psimpy.simulator.ravaflow24 import Ravaflow24Mixture
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.simulator.ravaflow24.Ravaflow24Mixture
     :members: preprocess, run, extract_impact_area, extract_qoi_max, extract_qoi_max_loc
\ No newline at end of file
diff --git a/docs/source/simulator/run_simulator.rst b/docs/source/simulator/run_simulator.rst
index 2c3d628..95efe48 100644
--- a/docs/source/simulator/run_simulator.rst
+++ b/docs/source/simulator/run_simulator.rst
@@ -1,19 +1,19 @@
 Run Simulator
--------------
+=============
 
 RunSimulator Class
-^^^^^^^^^^^^^^^^^^
+------------------
 
 The :class:`.RunSimulator` class is imported by::
     
     from psimpy.simulator.run_simulator import RunSimulator
 
 Methods
-*******
+^^^^^^^
 .. autoclass:: psimpy.simulator.run_simulator.RunSimulator
     :members: serial_run, parallel_run
 
 Attributes
-**********
+^^^^^^^^^^
 .. autoattribute:: psimpy.simulator.run_simulator.RunSimulator.var_samples
 .. autoattribute:: psimpy.simulator.run_simulator.RunSimulator.outputs
\ No newline at end of file
-- 
GitLab