From c1cbb2f78ce50afca6e9d1b3e8756c4e4cbcbd15 Mon Sep 17 00:00:00 2001
From: Robert Rosca <robert.rosca@xfel.eu>
Date: Thu, 18 Mar 2021 13:48:54 +0100
Subject: [PATCH] Improve formatting

---
 README.rst | 35 ++++++++++++++++++-----------------
 1 file changed, 18 insertions(+), 17 deletions(-)

diff --git a/README.rst b/README.rst
index e9952e17c..167a2ece7 100644
--- a/README.rst
+++ b/README.rst
@@ -196,8 +196,8 @@ yourself first:
 
   salloc -p exfel/upex -t 01:00:00
 
-where `-p` gives the partition to use: exfel or upex and `-t` the duration the
-node should be allocated. Then `ssh` onto that node.
+where `-p` gives the partition to use: exfel **or** upex and `-t` the duration
+the node should be allocated. Then ``ssh`` onto that node.
 
 Then activate your environment as described above (or just continue if you are
 not using a venv).
@@ -224,15 +224,16 @@ Finally run the script:
   python3 calibrate.py --input /gpfs/exfel/exp/SPB/201701/p002012/raw/r0100 \
     --output ../../test_out --mem-cells 30 --detector AGIPD --sequences 0,1
 
-Here `--input` should point to a directory of `RAW` files for the detector you
-are calibrating. They will be output into the folder specified by `--output`,
-which will have the run number or the last folder in the hierarchy of the input
-appended. Additionally, you need to specify the number of `--mem-cells` used for
-the run, as well as the `--detector`. Finally, you can optionally specify to
-only process certain `--sequences` of files, matching the sequence numbers of
-the `RAW` input. These should be given as a comma-separated list.
+Here ``--input`` should point to a directory of ``RAW`` files for the detector
+you are calibrating. They will be output into the folder specified by
+``--output``, which will have the run number or the last folder in the hierarchy
+of the input appended. Additionally, you need to specify the number of
+``--mem-cells`` used for the run, as well as the ``--detector``. Finally, you
+can optionally specify to only process certain ``--sequences`` of files,
+matching the sequence numbers of the `RAW` input. These should be given as a
+comma-separated list.
 
-Finally, there is a `--no-relgain` option, which disables relative gain
+Finally, there is a ``--no-relgain`` option, which disables relative gain
 correction. This can be useful while we still further characterize the detectors
 to provide accurate relative gain correction constants.
 
@@ -245,23 +246,23 @@ Important information that doesn't really fit in as part of the readme.
 
 TODO: Place this into the docs? Also, improve docs (out of scope for PR !437)
 
-GitLab Access for xcaltst and xcal
-==================================
+GitLab Access for ``xcaltst`` and ``xcal``
+==========================================
 
-To make it easier to work with and deploy software via xcaltst/xcal, we have
-created an xcal account for gitlab with the following details:
+To make it easier to work with and deploy software via ``xcaltst``/``xcal``, we
+have created an xcal account for gitlab with the following details:
 
 - Full Name: ReadOnly Gitlab Calibration External
 - User ID: 423
-- Username: xcalgitlab
+- Username: ``xcalgitlab``
 - Password: ask Robert Rosca
 
 This account is intended to be used as a read only account which can be given
 access to certain repos to make it easier to clone them when using our
 functional accounts on Maxwell.
 
-The xcaltst account has an ed25519 keypair under ``~/.ssh/gitlab/``, the public
-key has been added to the xcalgitlab's approved SSH keys.
+The ``xcaltst`` account has an ed25519 keypair under ``~/.ssh/gitlab/``, the
+public key has been added to the ``xcalgitlab``'s approved SSH keys.
 
 Additionally this block has been added to ``~/.ssh/config``:
 
-- 
GitLab