add sphinx_copybutton extension (#553)

* add sphinx_copybutton extension

* add a comment to the release notes

* add `sphinx_copybutton` to the pyproject.toml

* pin sphinx_copybutton version

* add suggestion to release notes

Author: mosc9575

doc/conf.py

@@ -42,8 +42,12 @@
     "nbsphinx",
     "nbsphinx_link",
     "sphinx.ext.imgconverter",  # for SVG conversion
+    "sphinx_copybutton",
 ]
 
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

doc/release_notes.rst

@@ -1,7 +1,10 @@
 Release Notes
 =============
 
-.. Upcoming Version
+Upcoming Version
+----------------
+
+* Add the `sphinx-copybutton` to the documentation
 
 Version 0.6.1
 --------------

pyproject.toml

@@ -52,6 +52,7 @@ docs = [
     "sphinx==7.3.7",
     "sphinx_rtd_theme==2.0.0",
     "sphinx_book_theme==1.1.3",
+    "sphinx-copybutton==0.5.2",
     "nbsphinx==0.9.4",
     "nbsphinx-link==1.3.0",
     "docutils<0.21",