Merge pull request numpy#26980 from mosc9575/26948_add_sphinx_copybutton

add sphinx-copybutton

Author: mattip

doc/source/conf.py

@@ -87,6 +87,7 @@ class PyTypeObject(ctypes.Structure):
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
     'sphinx.ext.mathjax',
+    'sphinx_copybutton',
     'sphinx_design',
 ]
 
@@ -285,6 +286,9 @@ def setup(app):
 plot_html_show_formats = False
 plot_html_show_source_link = False
 
+# sphinx-copybutton configurations
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
 # -----------------------------------------------------------------------------
 # LaTeX output
 # -----------------------------------------------------------------------------

environment.yml

@@ -29,6 +29,7 @@ dependencies:
   - mypy=1.10.0
   # For building docs
   - sphinx>=4.5.0
+  - sphinx-copybutton
   - sphinx-design
   - numpydoc=1.4.0
   - ipython

requirements/doc_requirements.txt

@@ -2,6 +2,7 @@
 sphinx==7.2.6
 numpydoc==1.4
 pydata-sphinx-theme>=0.15.2
+sphinx-copybutton
 sphinx-design
 scipy
 matplotlib