aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Suhling <tim@suhling.com>2024-08-23 12:41:37 +0200
committerTim Suhling <tim@suhling.com>2024-08-23 12:41:37 +0200
commit015182f030cc00fe59e6940f35d56bf91e3a4790 (patch)
treec44ec6eead783e4bf4f1d5c24fcc369e32b1cdf5 /docs
parent322ae0b0199528a247ecb64627c1d412b137a48d (diff)
Changed syntax highlighting for .rst code blocks
Diffstat (limited to 'docs')
-rw-r--r--docs/schrodinger_plot.rst6
-rw-r--r--docs/schrodinger_solve.rst9
2 files changed, 10 insertions, 5 deletions
diff --git a/docs/schrodinger_plot.rst b/docs/schrodinger_plot.rst
index e70ac01..9c5cb96 100644
--- a/docs/schrodinger_plot.rst
+++ b/docs/schrodinger_plot.rst
@@ -15,12 +15,14 @@ schrodinger_solve will limit the plot by the limits of the potential as well as
energies of the solution for a better initial result.
**Usage**
-::
+
+.. code-block:: text
schrodinger_plot.py [-h] [-s SOLUTION_DIR] [-o OUTPUT_DIR] [--show SHOW] [-e EXPORT] [--scale SCALE] [-x XLIM] [-y1 ENERGY_LIM] [-y2 UNCERTAINTY_LIM]
**Command line options**
-::
+
+.. code-block:: text
-h, --help show a help message
-s SOLUTION_DIR --solution_dir
diff --git a/docs/schrodinger_solve.rst b/docs/schrodinger_solve.rst
index 46a4596..26f8715 100644
--- a/docs/schrodinger_solve.rst
+++ b/docs/schrodinger_solve.rst
@@ -9,12 +9,14 @@ file describing the parameters to use and the potential (see below for file
format).
**Usage**
-::
+
+.. code-block:: text
schrodinger_solve [-h] [-o OUTPUT_DIR] filename
**Command line options**
-::
+
+.. code-block:: text
positional arguments:
filename File describing the system to solve
@@ -33,7 +35,8 @@ parameters are separated by whitespace characters (tab or space). Parameters
must be given in a fixed order. Comments discard the rest of the line and
may be added with a ``#`` character. An empty line is discarded and the next
non-empty line specifies the next parameter. A concrete example is given below.
-::
+
+.. code-block:: text
<mass>
<x-min> <x-max> <n-points>