add copybutton

apparebit · May 27, 2024 · f8e2fdf · f8e2fdf
1 parent aa2ada0
commit f8e2fdf
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -31,10 +31,11 @@ jobs:
         python-version: "3.12"
         cache: "pip"
 
-    - name: Install Sphinx & Autoprogram, Design, RTD Theme
+    - name: Install Sphinx & Autoprogram, Copy Button, Design, RTD Theme
       run: |
         python -m pip install --upgrade pip
-        pip install sphinx sphinxcontrib-autoprogram sphinx_design sphinx-rtd-theme
+        pip install sphinx sphinxcontrib-autoprogram
+        pip install sphinx-copybutton sphinx_design sphinx-rtd-theme
 
     - name: Set up Pages
       id: pages

diff --git a/docs/conf.py b/docs/conf.py
@@ -36,13 +36,15 @@
     #"sphinx.ext.extlinks",
     "sphinx.ext.viewcode",
     "sphinxcontrib.autoprogram",
+    "sphinx_copybutton",
     "sphinx_design",
     "sphinx_rtd_theme",
 ]
 
 napoleon_include_init_with_doc = True
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+copybutton_exclude = '.linenos, .gp, .go'
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/pyproject.toml b/pyproject.toml
@@ -13,6 +13,7 @@ dev = ["pyright", "flit"]
 doc = [
     "sphinx",
     "sphinxcontrib-autoprogram",
+    "sphinx-copybutton",
     "sphinx_design",
     "sphinx-rtd-theme",
 ]