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

DOC: Use the sphinx-copybutton extension in documentation

	modified:   .github/workflows/test-documentation-build.yml
	modified:   docs/source/conf.py
	modified:   etstool.py
	modified:   setup.py

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>

.github/workflows/test-documentation-build.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Install dependencies and local packages
       run: |
         python -m pip install --upgrade pip
-        python -m pip install Sphinx enthought_sphinx_theme
+        python -m pip install Sphinx enthought_sphinx_theme sphinx-copybutton
         python -m pip install .
     - name: Build HTML documentation with Sphinx
       run: |

docs/source/conf.py

@@ -46,6 +46,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
+    "sphinx_copybutton",
     "traits.util.trait_documenter",
 ]
 
@@ -116,6 +117,12 @@
 
 autodoc_member_order = "bysource"
 
+# Options for Sphinx copybutton extension
+# ---------------------------------------
+
+# Matches prompts - "$ ", ">>>" and "..."
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
 
 # Options for HTML output
 # -----------------------

etstool.py

@@ -101,6 +101,9 @@
     "traitsui",
 }
 
+# Dependencies that need to be installed from PyPO
+pypi_dependencies = {"sphinx-copybutton"}
+
 # Dependencies we install from source for testing
 source_dependencies = {"traitsui"}
 
@@ -189,6 +192,12 @@ def install(edm, runtime, environment, editable, source):
         install_stubs,
     ]
 
+    if pypi_dependencies:
+        commands += [
+            "{edm} run -e {environment} -- python -m pip install " + dep
+            for dep in pypi_dependencies
+        ]
+
     click.echo("Creating environment '{environment}'".format(**parameters))
     execute(commands, parameters)
     if source:

setup.py

@@ -303,6 +303,7 @@ def get_long_description():
         "docs": [
             "enthought-sphinx-theme",
             "Sphinx>=2.1.0,!=3.2.0",
+            "sphinx-copybutton",
         ],
         "test": [
             "Cython",