Add sphinx copybutton extension (#865)

* Add sphinx copybutton extension

* turn off copybutton for diff

Author: wxtim

setup.cfg

@@ -52,6 +52,7 @@ install_requires =
     hieroglyph>=2.1.0
     setuptools>=50
     sphinx>=7.1, !=7.4.4
+    sphinx-copybutton
     sphinx-design>=0.5.0
     sphinx_rtd_theme>=1.0.0
     sphinxcontrib-svg2pdfconverter

src/conf.py

@@ -57,6 +57,7 @@ def generate_task_icon_modifier_rst():
 sys.path.append(os.path.abspath('ext'))  # path to custom extensions.
 extensions = [
     # sphinx built-in extensions
+    'sphinx_copybutton',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.graphviz',
@@ -332,3 +333,6 @@ def generate_task_icon_modifier_rst():
 # Create sentence case versions of wordlist:
 sentence_case = [word.capitalize() for word in words]
 sentence_case_file.write_text('\n'.join(sentence_case) + '\n')
+
+# Turn off copybutton for diffs
+copybutton_selector = "div:not(.highlight-diff) > div.highlight > pre"