Merge pull request #683 from collective/682-add-sphinx-copybutton

Add sphinx-copybutton to allow copying code blocks with a single clic…
collective · Jul 3, 2024 · 0e93f36 · 0e93f36
2 parents 04bea14 + feba1c2
commit 0e93f36
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -65,10 +65,11 @@ New features:
 
 - Test compatibility with Python 3.12
 - Add function ``icalendar.use_pytz()``.
-- Add `sphinx-autobuild` for `livehtml` Makefile target.
+- Add ``sphinx-autobuild`` for ``livehtml`` Makefile target.
 - Add pull request preview on Read the Docs, building only on changes to documentation-related files.
 - Add link to pull request preview builds in the pull request description only when there are changes to documentation-related files.
 - Add documentation of live HTML preview of documentation and clean up of ``install.rst``.
+- Add ``sphinx-copybutton`` to allow copying code blocks with a single click of a button.
 
 Bug fixes:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
-    'sphinx.ext.viewcode'
+    'sphinx.ext.viewcode',
+    'sphinx_copybutton'
 ]
 source_suffix = '.rst'
 master_doc = 'index'

diff --git a/requirements_docs.txt b/requirements_docs.txt
@@ -1,4 +1,5 @@
 Sphinx>=1.2.3
 sphinx_rtd_theme
 sphinx-autobuild
+sphinx-copybutton
 .