Add copy button to documentation (#1124)

* add sphinx_copybutton and config

* update release notes

* add `sphinx-copybutton` to rtfd reqs

Author: tasansal

docs/conf.py

@@ -44,6 +44,7 @@
     'sphinx.ext.intersphinx',
     'numpydoc',
     'sphinx_issues',
+    "sphinx_copybutton",
 ]
 
 numpydoc_show_class_members = False
@@ -312,3 +313,9 @@ def setup(app):
 # :ref:`comparison manual <python:comparisons>`
 intersphinx_mapping = { 'python':('https://docs.python.org/', None), 
                         'numpy': ('https://numpy.org/doc/stable/', None)}
+
+
+# sphinx-copybutton configuration
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_line_continuation_character = "\\"
+copybutton_prompt_is_regexp = True

docs/release.rst

@@ -39,6 +39,7 @@ Documentation
 ~~~~~~~~~~~~~
 
 * Typo fixes to close quotes. By :user:`Pavithra Eswaramoorthy <pavithraes>`
+* Added copy button to documentation :user:`Altay Sansal <tasansal>`
 
 Maintenance
 ~~~~~~~~~~~

requirements_rtfd.txt

@@ -3,6 +3,7 @@ setuptools
 setuptools_scm
 sphinx
 sphinx-issues
+sphinx-copybutton
 sphinx-rtd-theme
 numpydoc
 numpy!=1.21.0