add docs copybutton (#47)

bjlittle · web-flow · commit 3043cbfa96f8 · 2020-05-23T04:05:28.000+01:00
diff --git a/ci/requirements/rtd.yml b/ci/requirements/rtd.yml
@@ -7,4 +7,5 @@ dependencies:
   - numpy
   - scipy
   - sphinx
+  - sphinx-copybutton
   - sphinx_rtd_theme
diff --git a/docs/tephi/source/conf.py b/docs/tephi/source/conf.py
@@ -44,6 +44,7 @@
               'matplotlib.sphinxext.plot_directive',
               'custom_class_autodoc',
               'generate_package_rst',
+              'sphinx_copybutton',
               ]
 
 # List of packages to document
@@ -269,3 +270,6 @@
     'numpy': ('http://docs.scipy.org/doc/numpy/', None),
     'matplotlib': ('http://matplotlib.sourceforge.net/', None),
 }
+
+# Define Python input prompt to copybutton.
+copybutton_prompt_text = ">>> "
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -9,4 +9,5 @@ pytest
 pytest-cov
 pytest-xdist
 sphinx
+sphinx-copybutton
 sphinx_rtd_theme

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@`
`44`	`44`	`'matplotlib.sphinxext.plot_directive',`
`45`	`45`	`'custom_class_autodoc',`
`46`	`46`	`'generate_package_rst',`
	`47`	`+ 'sphinx_copybutton',`
`47`	`48`	`]`
`48`	`49`
`49`	`50`	`# List of packages to document`
`@@ -269,3 +270,6 @@`
`269`	`270`	`'numpy': ('http://docs.scipy.org/doc/numpy/', None),`
`270`	`271`	`'matplotlib': ('http://matplotlib.sourceforge.net/', None),`
`271`	`272`	`}`
	`273`	`+`
	`274`	`+# Define Python input prompt to copybutton.`
	`275`	`+copybutton_prompt_text = ">>> "`