add a section on building the docs

Author: fionapigott

README.rst

@@ -831,3 +831,33 @@ commands, ran from the root directory in the repo:
     python setup.py bdist_wheel
     python setup.py sdist
     twine upload dist/*
+
+How to build the documentation:
+
+Building the documentation requires a few Sphinx packages to build the
+webpages:
+
+.. code:: bash
+
+    pip install sphinx
+    pip install sphinx_bootstrap_theme
+    pip install sphinxcontrib-napoleon
+
+Then (once your changes are committed to master) you should be able to
+run the documentation-generating bash script and follow the
+instructions:
+
+.. code:: bash
+
+    git checkout gh-pages
+    bash build_sphinx_docs.sh master searchtweets
+
+Note that this README is also generated, and so after any README changes
+you'll need to re-build the README (you need pandoc version 2.1+ for
+this) and commit the result:
+
+.. code:: bash
+
+..
+
+    bash make_readme.sh

examples/contributing.rst

@@ -16,3 +16,24 @@ For reference, distributing to Pypi is accomplished by the following commands, r
   python setup.py sdist
   twine upload dist/*
 
+How to build the documentation:
+
+Building the documentation requires a few Sphinx packages to build the webpages:
+
+.. code:: bash
+ 
+  pip install sphinx
+  pip install sphinx_bootstrap_theme
+  pip install sphinxcontrib-napoleon
+
+Then (once your changes are committed to master) you should be able to run the documentation-generating bash script and follow the instructions:
+
+.. code:: bash
+  
+  git checkout gh-pages
+  bash build_sphinx_docs.sh master searchtweets
+
+Note that this README is also generated, and so after any README changes you'll need to re-build the README (you need pandoc version 2.1+ for this) and commit the result:
+
+.. code:: bash 
+  bash make_readme.sh

examples/make_readme.sh

@@ -9,5 +9,5 @@ sed 's/.*parsed-literal.*/::/' credential_handling.rst > _credential_handling.rs
 mv _api_example.rst api_example.rst
 mv _credential_handling.rst credential_handling.rst
 
-/usr/local/bin/pandoc -i base_readme.rst --to rst | sed 's/ipython3/python/' > ../README.rst
+$(brew --prefix)/bin/pandoc -i base_readme.rst --to rst | sed 's/ipython3/python/' > ../README.rst
 #| sed 's/.*parsed-literal.*/::/'