Merge pull request #32 from ijnek/ijnek-use-requirements-txt

improve installation instructions by using requirements.txt

README.md

@@ -3,18 +3,21 @@
 Repository for maintaining the Sphinx Documentation for rUNSWift.
 
 ## Installing Dependencies
-`sudo apt install python3-sphinx-rtd-theme`
+
+```
+pip3 install -r requirements.txt
+```
 
 ## Compiling
-To compile locally, run `make html`. 
+To compile locally, run `make html`.
 The home documentation page can be opened by opening `build/html/index.html` in a browser.
 
 ## RTD
 The instructions for setting up the webhook for readthedocs is [here](https://docs.readthedocs.io/en/stable/webhooks.html#webhook-creation). For access to the project on readthedocs, [contact us](https://runswift.readthedocs.io/en/latest/contact.html).
 
 ## Editing Flowcharts (with draw.io)
 `source/draw.io/` contains **.png (with embedded XML)** that can be imported/exported by draw.io.
-To modify a diagram, 
+To modify a diagram,
 1. import the png file into draw.io
 2. make ammendments
 3. overwrite png file by exporting from draw.io

requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx-copybutton
+sphinx-rtd-theme

source/conf.py

@@ -29,7 +29,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.githubpages']
+extensions = [
+    'sphinx_copybutton'
+    'sphinx.ext.githubpages',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']