add copybutton for shell commands to docs

rjdbcm · Aug 21, 2021 · 6bc98f1 · 6bc98f1
1 parent d913dd4
commit 6bc98f1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/docs/_static/css/styles.css b/docs/_static/css/styles.css
@@ -23,6 +23,11 @@ a img.logo {
     border-color:#181a1b
 }
 
+button.copybtn {
+    opacity: 1;
+}
+
+
 .wy-side-nav-search {
     text-align: -moz-center;
 }

diff --git a/docs/conf.py b/docs/conf.py
@@ -37,8 +37,12 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx_rtd_theme"
+    "sphinx_rtd_theme",
+    "sphinx_copybutton"
 ]
+copybutton_only_copy_prompt_lines = True
+copybutton_prompt_text = "$ "
+copybutton_selector = "div.highlight-shell pre"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,4 @@ pyrsistent==0.18.0
 Pygments==2.10.0
 Cython==0.29.24
 numpy==1.21.2
+sphinx-copybutton==0.4.0