DOCS : Use the sphinx-copybutton extension in documentation (#503)

modified: docs/source/conf.py modified: setup.py
enthought · Jun 14, 2022 · 38b71f9 · 38b71f9
1 parent 434ae6c
commit 38b71f9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,6 +48,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
+    "sphinx_copybutton",
     "traits.util.trait_documenter",
 ]
 
@@ -114,6 +115,13 @@
     ("py:class", "wx."),
 ]
 
+# Options for Sphinx copybutton extension
+# ---------------------------------------
+
+# Matches prompts - "$ ", ">>>" and "..."
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
+
 # -- Options for Napoleon extension ---------------------------------------
 
 # Do pre-process NumPyDoc - style type strings. This prevents warnings

diff --git a/setup.py b/setup.py
@@ -58,6 +58,7 @@ def get_long_description():
             # Jinja2 is pinned for compatibility with the Sphinx pin.
             # xref: sphinx-doc/sphinx#10291
             "Jinja2<3.1",
+            "sphinx-copybutton",
         ],
     },
     packages=find_packages(exclude=["ci"]),