Merge pull request #2291 from VWS-Python/copybutton

Use sphinx-copybutton to add a copy button to documentation code blocks

Author: adamtheturtle

docs/source/conf.py

@@ -12,6 +12,7 @@
 author = "Adam Dangoor"
 
 extensions = [
+    "sphinx_copybutton",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
@@ -26,6 +27,10 @@
 year = datetime.datetime.now(tz=datetime.UTC).year
 project_copyright = f"{year}, {author}"
 
+# Exclude the prompt from copied code with sphinx_copybutton.
+# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies.
+copybutton_exclude = ".linenos, .gp"
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.

pyproject.toml

@@ -59,6 +59,7 @@ optional-dependencies.dev = [
     "pyyaml==6.0.1",
     "ruff==0.5.5",
     "sphinx==7.4.7",
+    "sphinx-copybutton==0.5.2",
     "sphinx-substitution-extensions==2024.2.25",
     "sphinxcontrib-spelling==8",
     "sybil==6.1.1",