From dc1c466d627e315680e627339b7426c927154e0c Mon Sep 17 00:00:00 2001
From: Quentin Remy <quentin.remy@mpi-hd.mpg.de>
Date: Mon, 6 May 2024 18:19:01 +0200
Subject: [PATCH 1/2] Remove $ in bash commands

Signed-off-by: Quentin Remy <quentin.remy@mpi-hd.mpg.de>
---
 docs/development/dev_howto.rst            | 10 ++---
 docs/development/doc_howto.rst            |  2 +-
 docs/development/intro.rst                |  2 +-
 docs/getting-started/usage.rst            |  4 +-
 docs/user-guide/scripts/index.rst         | 52 +++++++++++------------
 examples/tutorials/scripts/survey_map.rst |  2 +-
 6 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/docs/development/dev_howto.rst b/docs/development/dev_howto.rst
index b1b0ae5a4c..4f4d210c89 100644
--- a/docs/development/dev_howto.rst
+++ b/docs/development/dev_howto.rst
@@ -526,11 +526,11 @@ Here's to commands to check for and fix this (see `here <http://stackoverflow.co
 
 .. code-block:: bash
 
-    $ git clean -fdx
-    $ find . -type f -print0 | xargs -0 -n 1 -P 4 dos2unix -c mac
-    $ find . -type f -print0 | xargs -0 -n 1 -P 4 dos2unix -c ascii
-    $ git status
-    $ cd astropy_helpers && git checkout -- . && cd ..
+    git clean -fdx
+    find . -type f -print0 | xargs -0 -n 1 -P 4 dos2unix -c mac
+    find . -type f -print0 | xargs -0 -n 1 -P 4 dos2unix -c ascii
+    git status
+    cd astropy_helpers && git checkout -- . && cd ..
 
 Making a pull request that requires backport
 ++++++++++++++++++++++++++++++++++++++++++++
diff --git a/docs/development/doc_howto.rst b/docs/development/doc_howto.rst
index 2082dfbc10..dc935291b9 100644
--- a/docs/development/doc_howto.rst
+++ b/docs/development/doc_howto.rst
@@ -228,7 +228,7 @@ To check for broken external links you can use ``tox``:
 
 .. code-block:: bash
 
-   $ tox -e linkcheck
+   tox -e linkcheck
 
 Include png files as images
 ----------------------------
diff --git a/docs/development/intro.rst b/docs/development/intro.rst
index 5ab27d15d4..386c9f4660 100644
--- a/docs/development/intro.rst
+++ b/docs/development/intro.rst
@@ -191,7 +191,7 @@ environment with the content present in `environment-dev.yml` see below:
 
 .. code-block:: bash
 
-    $ conda env update --file environment-dev.yml --prune
+    conda env update --file environment-dev.yml --prune
 
 
 When developing Gammapy you never want to work on the ``main`` branch, but
diff --git a/docs/getting-started/usage.rst b/docs/getting-started/usage.rst
index 4e33ee4946..3e2cf64b32 100644
--- a/docs/getting-started/usage.rst
+++ b/docs/getting-started/usage.rst
@@ -42,7 +42,7 @@ Gammapy is a Python package, so you can of course import and use it from Python:
 
 .. code-block:: bash
 
-    $ python
+    python
     Python 3.6.0 | packaged by conda-forge | (default, Feb 10 2017, 07:08:35)
     [GCC 4.2.1 Compatible Apple LLVM 7.3.0 (clang-703.0.31)] on darwin
     Type "help", "copyright", "credits" or "license" for more information.
@@ -58,7 +58,7 @@ IPython is nicer to use for interactive analysis:
 
 .. code-block:: bash
 
-    $ ipython
+    ipython
     Python 3.6.0 | packaged by conda-forge | (default, Feb 10 2017, 07:08:35)
     Type 'copyright', 'credits' or 'license' for more information
     IPython 6.5.0 -- An enhanced Interactive Python. Type '?' for help.
diff --git a/docs/user-guide/scripts/index.rst b/docs/user-guide/scripts/index.rst
index dc9ad691fb..493fbdaa7f 100644
--- a/docs/user-guide/scripts/index.rst
+++ b/docs/user-guide/scripts/index.rst
@@ -32,13 +32,13 @@ To execute the Gammapy CLI, type the command ``gammapy`` at your terminal shell
 
 .. code-block:: bash
 
-    $ gammapy --help
+    gammapy --help
 
 or equivalently, just type this:
 
 .. code-block:: bash
 
-    $ gammapy
+    gammapy
 
 Either way, the command should print some help text to the console and then
 exit:
@@ -60,10 +60,10 @@ exit:
       Examples
       --------
 
-      $ gammapy --help
-      $ gammapy --version
-      $ gammapy info --help
-      $ gammapy info
+      gammapy --help
+      gammapy --version
+      gammapy info --help
+      gammapy info
 
       Options:
       --log-level [debug|info|warning|error]
@@ -100,7 +100,7 @@ a datastore and producing the reduced datasets.)
 
 .. code-block:: bash
 
-    $ gammapy analysis --help
+    gammapy analysis --help
     Usage: gammapy analysis [OPTIONS] COMMAND [ARGS]...
 
     Automation of configuration driven data reduction process.
@@ -108,11 +108,11 @@ a datastore and producing the reduced datasets.)
     Examples
     --------
 
-    $ gammapy analysis config
-    $ gammapy analysis run
-    $ gammapy analysis config --overwrite
-    $ gammapy analysis config --filename myconfig.yaml
-    $ gammapy analysis run --filename myconfig.yaml
+    gammapy analysis config
+    gammapy analysis run
+    gammapy analysis config --overwrite
+    gammapy analysis config --filename myconfig.yaml
+    gammapy analysis run --filename myconfig.yaml
 
     Options:
     -h, --help  Show this message and exit.
@@ -121,7 +121,7 @@ a datastore and producing the reduced datasets.)
     config  Writes default configuration file.
     run     Performs automated data reduction process.
 
-    $ gammapy analysis config
+    gammapy analysis config
     INFO:gammapy.scripts.analysis:Configuration file produced: config.yaml
 
 
@@ -129,7 +129,7 @@ You can manually edit this produced configuration file and the run the data redu
 
 .. code-block:: text
 
-    $ gammapy analysis run
+    gammapy analysis run
 
     INFO:gammapy.analysis.config:Setting logging config: {'level': 'INFO', 'filename': None, 'filemode': None, 'format': None, 'datefmt': None}
     INFO:gammapy.analysis.core:Fetching observations.
@@ -186,7 +186,7 @@ execute it via:
 
 .. code-block:: bash
 
-    $ python significance.py
+    python significance.py
 
 If you want, you can also put the line ``#!/usr/bin/env python`` at the top of
 the script, make it executable via ``chmod +x significance.py`` and then you'll
@@ -213,7 +213,7 @@ you to set analysis parameters without having to edit the file, like this:
 
 .. code-block:: bash
 
-    $ python significance.py --help
+    python significance.py --help
       Usage: significance.py [OPTIONS] N_OBSERVED MU_BACKGROUND
 
       Compute significance for a Poisson count observation.
@@ -225,10 +225,10 @@ you to set analysis parameters without having to edit the file, like this:
       --value [sqrt_ts|p_value]  Square root TS or p_value
       --help                     Show this message and exit.
 
-    $ python significance.py 10 4.2
+    python significance.py 10 4.2
     2.39791813
 
-    $ python significance.py 10 4.2 --value p_value
+    python significance.py 10 4.2 --value p_value
     0.01648855015875024
 
 In Python, there are several ways to do command line argument parsing and to
@@ -290,7 +290,7 @@ This usually looks like this:
 
 .. code-block:: bash
 
-    $ gammapy
+    gammapy
     -bash: gammapy: command not found
 
 If you just installed Gammapy, search the install log for the message
@@ -306,7 +306,7 @@ installed, you can try calling it like this instead:
 
 .. code-block:: bash
 
-    $ python -m gammapy
+    python -m gammapy
 
 This also has the advantage that it avoids issues where users have multiple
 versions of Python and Gammapy installed and accidentally launch one they don't
@@ -318,18 +318,18 @@ Gammapy installed:
 
 .. code-block:: bash
 
-    $ which python
-    $ python -c 'import gammapy'
+    which python
+    python -c 'import gammapy'
 
 To see more information about your shell environment, these commands might be
 helpful:
 
 .. code-block:: bash
 
-    $ python -m site
-    $ python -m gammapy info
-    $ echo $PATH
-    $ conda info -a # if you're using conda
+    python -m site
+    python -m gammapy info
+    echo $PATH
+    conda info -a # if you're using conda
 
 If you're still stuck or have any question, feel free to ask for help with
 installation issues on the Gammapy mailing list of Slack any time!
diff --git a/examples/tutorials/scripts/survey_map.rst b/examples/tutorials/scripts/survey_map.rst
index cc18c58517..c14e785134 100644
--- a/examples/tutorials/scripts/survey_map.rst
+++ b/examples/tutorials/scripts/survey_map.rst
@@ -13,4 +13,4 @@ To execute it run:
 
 .. code-block:: bash
 
-    $ python survey_example.py
+    python survey_example.py

From d2ab20cecccb6d74c847be1e4ee34019a89444fe Mon Sep 17 00:00:00 2001
From: Astro-Kirsty <AstroKirsty@gmail.com>
Date: Tue, 7 May 2024 12:16:45 +0200
Subject: [PATCH 2/2] Update docs/user-guide/scripts/index.rst

---
 docs/user-guide/scripts/index.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/user-guide/scripts/index.rst b/docs/user-guide/scripts/index.rst
index 493fbdaa7f..f89375e14e 100644
--- a/docs/user-guide/scripts/index.rst
+++ b/docs/user-guide/scripts/index.rst
@@ -125,9 +125,9 @@ a datastore and producing the reduced datasets.)
     INFO:gammapy.scripts.analysis:Configuration file produced: config.yaml
 
 
-You can manually edit this produced configuration file and the run the data reduction process::
+You can manually edit this produced configuration file and the run the data reduction process:
 
-.. code-block:: text
+.. code-block:: bash
 
     gammapy analysis run