Merge pull request #5 from gassmoeller/fix_readthedocs

Fixes to the readthedocs configuration and the documentation

Author: gassmoeller

.readthedocs.yaml

@@ -12,12 +12,12 @@ build:
 
 # Build documentation in the root directory with Sphinx
 sphinx:
-  configuration: ./doc/sphinx_template/docs/conf.py
+  configuration: ./doc/sphinx_template/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - htmlzip
   - pdf
 
 conda:
-  environment: ./doc/sphinx/environment.yml
+  environment: ./doc/sphinx_template/environment.yml

doc/README.md

@@ -1,11 +1,12 @@
 This directory should contain the documentation for your software. For the
-official manual template in tex provided by the Computational Infrastructure for
-Geodynamics, see:
+official manual template in LaTex, see:
 https://github.com/geodynamics/best_practices/tree/master/software_manual_template
 
-To generate html documentation using sphinx, see the directory /sphinx_template. 
-Navigate to sphinx_template/docs/_build/html and double click on index.html to access
-instructions on how to use the template and to view the example.
+For the official Sphinx documentation template see https://software-template.readthedocs.io,
+which also includes information on how to build the documentation locally
+in the /sphinx_template directory.
+After building the documentation you can navigate to sphinx_template/_build/html
+and double click on index.html to view the example offline.
 
 Keep in mind that your code should ideally also use an in-source documentation
 system like doxygen or autodoc. We recommend writing your manual in LaTeX (like