Update documentation to use RTD theme

Author: wcarthur

Diff for: conf.py

@@ -12,6 +12,7 @@
 # serve to show the default.
 
 import sys, os
+import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -50,7 +51,7 @@
 # The short X.Y version.
 version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.0.'
+release = '2.0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -91,20 +92,22 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
-
+#html_theme = 'classic'
+RTD_NEW_THEME = True
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    "sidebarbgcolor": "#006699",
-    "sidebartextcolor": "#e7e7e7",
-    "sidebarlinkcolor": "#e7e7e7",
-    "relbarbgcolor": "#66aacc",
-    "bgcolor": "#e7e7e7",
-    "headfont": "Helvetica",
-    "footerbgcolor": "#2f2f2f",
-    "codebgcolor": "#c8c8c8"}
+#html_theme_options = {
+#    "sidebarbgcolor": "#006699",
+#    "sidebartextcolor": "#e7e7e7",
+#    "sidebarlinkcolor": "#e7e7e7",
+#    "relbarbgcolor": "#66aacc",
+#    "bgcolor": "#e7e7e7",
+#    "headfont": "Helvetica",
+#    "footerbgcolor": "#2f2f2f",
+#    "codebgcolor": "#c8c8c8"}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

Diff for: docs/contributing.rst

@@ -1,3 +1,4 @@
+.. _contributing: 
 
 =================
 Contributing code

Diff for: docs/install.rst

@@ -30,13 +30,24 @@ TCRM.
 Setting the environment
 -----------------------
 
-To enable TCRM to run flawlessly, you may need to change some environment settings. The important variable to set is the ``PYTHONPATH`` variable. This should be set to the path where you have extracted the contents of the zip file. In the examples below, change ``/path/to/tcrm`` to the location where you extracted the TCRM files.
+To enable TCRM to run flawlessly, you may need to change some
+environment settings. The important variable to set is the
+``PYTHONPATH`` variable. This should be set to the path where you have
+extracted the contents of the zip file. In the examples below, change
+``/path/to/tcrm`` to the location where you extracted the TCRM files.
 
-A complete discussion on environment variables in Python is given in the `Python documentation <https://docs.python.org/2/using/cmdline.html#environment-variables>`_. 
+A complete discussion on environment variables in Python is given in
+the `Python documentation
+<https://docs.python.org/2/using/cmdline.html#environment-variables>`_.
 
 Windows
 ~~~~~~~
-The Python documentation contains some simple instructions for setting environment variables on Windows systems `here <https://docs.python.org/2/using/windows.html>`_. See `this link <http://www.computerhope.com/issues/ch000549.htm>`_ for setting the variables on different Windows systems.
+
+The Python documentation contains some simple instructions for setting
+environment variables on Windows systems `here
+<https://docs.python.org/2/using/windows.html>`_. See `this link
+<http://www.computerhope.com/issues/ch000549.htm>`_ for setting the
+variables on different Windows systems.
 
 BASH shell
 ~~~~~~~~~~
@@ -120,7 +131,7 @@ From the base directory, execute the build process::
 Ubuntu
 ~~~~~~
 The github branch issue_25 (created from the v2.0 branch) had an environment created by `installing miniconda
-<https://conda.io/docs/install/quick.html#linux-miniconda-install>`_ and executing the following commands.
+<https://conda.io/docs/install/quick.html#linux-miniconda-install>`_ and executing the following commands::
 
         ~/miniconda2/bin/conda create --name tcrm
         ~/miniconda2/bin/source activate tcrm
@@ -136,39 +147,50 @@ The github branch issue_25 (created from the v2.0 branch) had an environment cre
         ~/miniconda2/bin/pip --proxy=http://localhost:3128 install simplejson
 
 
-The following libraries were needed to compile the C extensions, and run the unit tests:
+The following libraries were needed to compile the C extensions, and run the unit tests::
+
     sudo apt install libgl1-mesa-glx
     sudo apt-get install python-numpy-dev
 
-The C extensions were compiled from the trcm directory with:
+The C extensions were compiled from the trcm directory with::
+
         (tcrm) user@server:~/tcrm$ python intaller/setup.py build_ext -i
 
 An error occurred where the include file seems to have changed paths. It may be a one off,
 or it may reoccur in another version of Linux. The error was in KPDF.c and the change was to
-comment out one line and replace it with another.
+comment out one line and replace it with another.::
 
         #include "numpy/arrayobject.h"
         /* #include "arrayobject.h" */
 
 A requiremements file was created in the root directory called ``linux_v20.yml`` and should (it hasn't been tested)
-replace the ``conda install`` commands above. The command to use this file is:
+replace the ``conda install`` commands above. The command to use this file is::
 
         conda env create -f linux_v20.yml
 
-Activating the environment would be
+Activating the environment would be::
+
         source activate linux_v20
 
 
 Windows
 ~~~~~~~
 
 For Windows users, the code includes the ``compile.cmd`` script in the
-main TCRM diretory that will build these extensions in place. By default, TCRM uses the MinGW suite (http://www.mingw.org) for compiling the extensions. Other Windows-based packages can also be used (e.g. Cygwin). See the Python documentation on writing configuration files for the :mod:`distutils` package for more details.
+main TCRM diretory that will build these extensions in place. By
+default, TCRM uses the MinGW suite (http://www.mingw.org) for
+compiling the extensions. Other Windows-based packages can also be
+used (e.g. Cygwin). See the Python documentation on writing
+configuration files for the :mod:`distutils` package for more details.
 
 Notes
 ~~~~~
 
-It is recommended to use a stand-alone Python installation for compiling and running TCRM. Installations linked to other software such as ArcGIS have resulted in compilation errors, as the required :mod:`numpy` libraries are pre-compiled and packaged with such installations. 
+It is recommended to use a stand-alone Python installation for
+compiling and running TCRM. Installations linked to other software
+such as ArcGIS have resulted in compilation errors, as the required
+:mod:`numpy` libraries are pre-compiled and packaged with such
+installations.
 
 .. _testing:
 

Diff for: index.rst

@@ -23,6 +23,8 @@ to each event. Finally an extreme value distribution is fitted to the
 aggregated windfields at each grid point in the model domain to
 provide ARI wind speed estimates.
 
+TCRM can be downloaded from our GitHub repository: http://github.com/GeoscienceAustralia/tcrm
+
 Features
 ========
 
@@ -50,7 +52,7 @@ Bleeding edge versions are accessible `here <https://github.com/GeoscienceAustra
 
 Contributions are welcome -- create a `fork
 <https://github.com/GeoscienceAustralia/tcrm/fork>`_ or clone the
-repo.
+repo, but please read the :ref:`Contributing code<contributing>` section first.
 
 Contents
 ========