update sphinx-copybutton to v0.3.0

renamed understanding-spin_systems.rst to introduction.rst removed reduce_pdf.sh
deepanshs · Jul 25, 2020 · cae25e1 · cae25e1
1 parent f641430
commit cae25e1
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 56 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -137,7 +137,7 @@
 }
 # ---------------------------------------------------------------------------- #
 
-copybutton_prompt_text = ">>> |\\\\$ |\\[\\d*\\]: |\\.\\.\\.: |[.][.][.] "
+copybutton_prompt_text = ">>> |\\$ |\\[\\d*\\]: |\\.\\.\\.: |[.][.][.] "
 copybutton_prompt_is_regexp = True
 
 # ---------------------------------------------------------------------------- #

diff --git a/docs/index.rst b/docs/index.rst
@@ -148,7 +148,7 @@ Our current objectives for the future are the following
 
     installation
     requirements
-    understanding-spin_systems
+    introduction
     getting_started
     using_mrsimulator_objects
     configuring_simulator

diff --git a/docs/understanding-spin_systems.rst → docs/introduction.rst b/docs/understanding-spin_systems.rst → docs/introduction.rst
@@ -80,25 +80,25 @@ Uncoupled spin-systems
 
 .. _listing_1H-12C:
 .. code-block:: json
-   :linenos:
-   :caption: An example 1H-12C isotopomer in JSON representation.
-
-    {
-        "name": "1H-12C",
-        "description": "An optional description of the spin-system/isotopomer",
-        "sites": [
-            {
-                "isotope": "1H",
-                "isotropic_chemical_shift": "-1.2 ppm",
-                "shielding_symmetric": {
-                    "zeta": "4.12 ppm",
-                    "eta": 0.12
-                }
-            }
-        ],
-        "couplings": [],
-        "abundance": "98.915%"
-    }
+  :linenos:
+  :caption: An example 1H-12C isotopomer in JSON representation.
+
+  {
+      "name": "1H-12C",
+      "description": "An optional description of the spin-system/isotopomer",
+      "sites": [
+          {
+              "isotope": "1H",
+              "isotropic_chemical_shift": "-1.2 ppm",
+              "shielding_symmetric": {
+                  "zeta": "4.12 ppm",
+                  "eta": 0.12
+              }
+          }
+      ],
+      "couplings": [],
+      "abundance": "98.915%"
+  }
 
 :numref:`listing_1H-12C` is an example of the spin-system corresponding to the
 `1H-12C` isotopomer, serialized using the JavaScript Object Notation (JSON). At the
@@ -130,33 +130,33 @@ and its attributes.
 
 .. _listing_2H-12C:
 .. code-block:: json
-   :linenos:
-   :emphasize-lines: 12-18
-   :caption: An example 2H-12C isotopomer in JSON representation.
-
-    {
-        "name": "2H-12C",
-        "description": "An optional description on the isotopomer",
-        "sites": [
-            {
-                "isotope": "2H",
-                "isotropic_chemical_shift": "4.1 ppm",
-                "shielding_symmetric": {
-                    "zeta": "12.12 ppm",
-                    "eta": 0.82
-                },
-                "quadrupolar": {
-                    "Cq": "1.47 MHz",
-                    "eta": 0.27,
-                    "alpha": "0.212 rad",
-                    "beta": "1.231 rad",
-                    "gamma": "3.1415 rad"
-                }
-            }
-        ],
-        "coupling": [],
-        "abundance": "0.148%"
-    }
+  :linenos:
+  :emphasize-lines: 12-18
+  :caption: An example 2H-12C isotopomer in JSON representation.
+
+  {
+      "name": "2H-12C",
+      "description": "An optional description on the isotopomer",
+      "sites": [
+          {
+              "isotope": "2H",
+              "isotropic_chemical_shift": "4.1 ppm",
+              "shielding_symmetric": {
+                  "zeta": "12.12 ppm",
+                  "eta": 0.82
+              },
+              "quadrupolar": {
+                  "Cq": "1.47 MHz",
+                  "eta": 0.27,
+                  "alpha": "0.212 rad",
+                  "beta": "1.231 rad",
+                  "gamma": "3.1415 rad"
+              }
+          }
+      ],
+      "coupling": [],
+      "abundance": "0.148%"
+  }
 
 :numref:`listing_2H-12C` is an example of a spin-system representing the `2H-12C`
 isotopomer. This example is similar to the example from :numref:`listing_1H-12C`,

diff --git a/docs/reduce_pdf.sh b/docs/reduce_pdf.sh
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -23,5 +23,5 @@ sphinx>=2.0
 sphinx-gallery>0.6.2
 pillow>=7.1.2  # for sphinx-gallery images
 breathe>4.19
-sphinx_copybutton>=0.2.12
+sphinx_copybutton>=0.3.0
 sphinx-tabs>=1.1.13