Add sphinx-copybutton extension to easily copy codes

doc/_static/style.css

@@ -114,3 +114,20 @@ h1 {
         margin-top: 20px;
     }
 }
+
+/* Style for the copy button */
+/* Safe to remove for sphinx-copybutton>0.3.1
+ * https://github.com/executablebooks/sphinx-copybutton/pull/107
+ */
+a.copybtn {
+    position: absolute;
+    top: .2em;
+    right: .2em;
+    width: 1.3em;
+    height: 1.3em;
+    opacity: .3;
+    transition: opacity 0.5s;
+    border: none;
+    user-select: none;
+}
+

doc/conf.py

@@ -28,6 +28,7 @@
     "sphinx.ext.napoleon",
     "nbsphinx",
     "sphinx_gallery.gen_gallery",
+    "sphinx_copybutton",
 ]
 
 # Autosummary pages will be generated by sphinx-autogen instead of sphinx-build
@@ -52,6 +53,13 @@
     "xarray": ("http://xarray.pydata.org/en/stable/", None),
 }
 
+# options for sphinx-copybutton
+# https://sphinx-copybutton.readthedocs.io
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+copybutton_only_copy_prompt_lines = True
+copybutton_remove_prompts = True
+
 sphinx_gallery_conf = {
     # path to your examples scripts
     "examples_dirs": [

environment.yml

@@ -26,5 +26,6 @@ dependencies:
     - pytest-mpl
     - pytest>=6.0
     - sphinx
+    - sphinx-copybutton
     - sphinx-gallery
     - sphinx_rtd_theme=0.4.3

requirements-dev.txt

@@ -14,5 +14,6 @@ pytest-cov
 pytest-mpl
 pytest>=6.0
 sphinx
+sphinx-copybutton
 sphinx-gallery
 sphinx_rtd_theme==0.4.3