add sphinx-copybutton extension to documentation (#579)

* add sphinx-copybutton extension to documentation

* add sphinx-copybutton to the test yaml

---------

Co-authored-by: Dave Woodruff <david.l.woodruff@gmail.com>

Author: mosc9575

.github/workflows/test_pr_and_main.yml

@@ -63,7 +63,7 @@ jobs:
       - name: Install dependencies
         run: |
           conda install mpi4py pandas setuptools
-          pip install pyomo sphinx sphinx_rtd_theme dill gridx-egret cplex pybind11
+          pip install pyomo sphinx sphinx_rtd_theme sphinx-copybutton dill gridx-egret cplex pybind11
           pip install xpress
 
       - name: Build pyomo extensions

doc/src/conf.py

@@ -42,16 +42,23 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.coverage',
-              'sphinx.ext.mathjax',
-              'sphinx.ext.viewcode',
-              'sphinx.ext.napoleon',
-              'sphinx.ext.ifconfig',
-              'sphinx.ext.inheritance_diagram',
-              'sphinx.ext.autosummary',
-              'sphinx.ext.doctest']
-    #'sphinx.ext.githubpages']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
+    #'sphinx.ext.githubpages',
+    "sphinx_copybutton",
+]
+
+# allow the sphinx-copybutton to remove prompt text
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
 
 viewcode_import = True
 #napoleon_include_private_with_doc = True

pyproject.toml

@@ -38,8 +38,9 @@ tracker = "https://github.com/Pyomo/mpi-sppy/issues"
 
 [project.optional-dependencies]
 doc = [
-    "sphinx_rtd_theme",
     "sphinx",
+    "sphinx-copybutton",
+    "sphinx_rtd_theme",
 ]
 mpi = [
     "mpi4py>=3.0.3"