Merge branch 'update-zcashd-pkg-instructions' into 'master'

Add copy button functionality See merge request zcash-docs/zcash-docs!235
Electric-Coin-Company · Oct 20, 2020 · d5da04c · d5da04c
2 parents 336d2ea + f24549c
commit d5da04c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -22,7 +22,7 @@ stages:
 # user-guide README
 before_script:
   - apk add make git
-  - pip3 install sphinx sphinx_rtd_theme sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap
+  - pip3 install sphinx sphinx_rtd_theme sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap sphinx-copybutton
 
 # main job to build the RTD stack in the docker runner  
 build_job:

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ sudo apt-get install python3-pip
 Get required packages for ReadtheDocs build:
 
 ```bash
-pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap
+pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap sphinx-copybutton
 ```
 
 ### macOS
@@ -27,7 +27,7 @@ If you are using `brew`, please issue the following:
 
 ```bash
 brew install python3
-pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap
+pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap sphinx-copybutton
 ```
 
 If you are **not** using `brew`, please verify version of OS:
@@ -57,7 +57,7 @@ easy_install pip3
 Get required packages for ReadtheDocs build:
 
 ```bash
-pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap
+pip3 install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome recommonmark sphinx-sitemap sphinx-copybutton
 ```
 
 If you are unable to build the above packages, please compile them from source:

diff --git a/source/conf.py b/source/conf.py
@@ -40,7 +40,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 # TODO research sphinxcontrib.osexample
-extensions = ['sphinx.ext.intersphinx', 'sphinx_fontawesome','recommonmark','sphinx_sitemap']
+extensions = ['sphinx.ext.intersphinx', 'sphinx_fontawesome','recommonmark','sphinx_sitemap','sphinx_copybutton']
 
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/source/requirements.txt b/source/requirements.txt
@@ -1,3 +1,4 @@
 sphinx-fontawesome==0.0.6
 sphinx-rtd-theme==0.5.0                             
 sphinx-sitemap==2.2.0 
+sphinx-copybutton==0.3.0