Use the "sphinx-copybutton" extension in documentation (#948)

* DOC: Use the sphinx-copybutton extension in documentation modified: ci/edmtool.py modified: docs/source/conf.py modified: enable/__init__.py * Update ci/edmtool.py
enthought · Jun 13, 2022 · 855106c · 855106c
1 parent 8abaa17
commit 855106c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/ci/edmtool.py b/ci/edmtool.py
@@ -293,6 +293,7 @@ def docs(runtime, toolkit, environment):
     ])
     commands = [
         "edm install -y -e {environment} " + packages,
+        "edm run -e {environment} -- python -m pip install sphinx-copybutton",
     ]
     click.echo(
         "Installing documentation tools in  '{environment}'".format(

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -38,6 +38,7 @@
     "sphinx.ext.napoleon",
     # Link to code in sphinx generated API docs
     "sphinx.ext.viewcode",
+    "sphinx_copybutton",
     # Include trait definition comments in autogenerated API docs
     "traits.util.trait_documenter",
 ]
@@ -98,6 +99,12 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# Options for Sphinx copybutton extension
+# ---------------------------------------
+
+# Matches prompts - "$ ", ">>>" and "..."
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
 
 # Options for HTML output
 # -----------------------

diff --git a/enable/__init__.py b/enable/__init__.py
@@ -20,6 +20,8 @@
 ]
 
 __extras_require__ = {
+    # Dependencies for documentation
+    "docs": ["enthought-sphinx-theme", "sphinx", "sphinx-copybutton"],
     # Dependencies for running enable/kiva's examples
     "examples": ["chaco", "mayavi", "scipy", "kiwisolver", "pyglet"],
     # Dependencies for GL backend support