Update doc for ReadTheDocs

MassimoCimmino · Oct 10, 2017 · 272e0ab · 272e0ab
1 parent 5494a2c
commit 272e0ab
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -44,15 +44,17 @@ following packages are needed to run *pygfunction* and its examples:
 The documentation is generated using [Sphinx](http://www.sphinx-doc.org). The
 following packages are needed to build the documentation:
 - sphinx (>= 1.5.1)
-- sphinx-bootstrap-theme (>= 0.4.14)
 - numpydoc (>= 0.6.0)
 
 
 ## Quick start
 
-To get the latest version of the code, you can [download the repository from
-github](https://github.com/MassimoCimmino/pygfunction) or clone the project
-in a local directory using git:
+**Users** - [Download the latest release
+](https://github.com/MassimoCimmino/pygfunction/releases).
+
+**Developers** - To get the latest version of the code, you can [download the
+repository from github](https://github.com/MassimoCimmino/pygfunction) or clone
+the project in a local directory using git:
 
 ```
 git clone https://github.com/MassimoCimmino/pygfunction.git
@@ -62,6 +64,12 @@ Once *pygfunction* is copied to a local directory, you can verify that it is
 working properly by running the examples in `pygfunction/examples/`.
 
 
+## Quick start
+
+*pygfunction*'s documentation is hosted on
+[ReadTheDocs](https://pygfunction.readthedocs.io).
+
+
 ## Contributing to *pygfunction*
 
 You can report bugs and propose enhancements on the

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -81,7 +81,7 @@
 # The short X.Y version.
 version = u'0.2'
 # The full version, including alpha/beta/rc tags.
-release = u'0.2.0'
+release = u'0.2.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/source/install.rst b/doc/source/install.rst
@@ -11,11 +11,18 @@ Setting up pygfunction
 
 *pygfunction*'s- documentation is built using:
 	- sphinx (>= 1.5.1)
-	- sphinx-bootstrap-theme (>= 0.4.14)
 	- numpydoc (>= 0.6.0)
 
-To use *pygfunction*, clone or download the repository from
-https://github.com/MassimoCimmino/pygfunction to a local directory.
+**Users** - [Download the latest release
+](https://github.com/MassimoCimmino/pygfunction/releases).
+
+**Developers** - To get the latest version of the code, you can [download the
+repository from github](https://github.com/MassimoCimmino/pygfunction) or clone
+the project in a local directory using git:
+
+```
+git clone https://github.com/MassimoCimmino/pygfunction.git
+```
 
 Test that *pygfunction* is running correctly by running any of the
 provided examples in ``../pygfunction/examples/``