doc - change theme, add png

nismod · Aug 17, 2017 · 8d040d2 · 8d040d2
1 parent 612b4e7
commit 8d040d2
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 12 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -2,5 +2,6 @@
 Developers
 ==========
 
-* Will Usher <william.usher@ouce.ox.ac.uk>
 * Sven Eggimann <sven.eggimann@ouce.ox.ac.uk>
+* Will Usher <william.usher@ouce.ox.ac.uk>
+* Tom Russel <tom.russel@ouce.ox.ac.uk>
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,6 +5,11 @@ Changelog
 Version 0.1
 ===========
 
-- Feature A added
-- FIX: nasty bug #1729 fixed
-- add your changes here!
+- Starting with development
+
+
+Version 0.2
+===========
+
+- Residential, service and industry sector
+- blabla
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,8 @@
 # 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
+#sys.path.insert(0, os.path.abspath('.')) 
+sys.path.append(os.path.join(os.path.dirname(__name__), '..')) #Added manually
 
 # Support markdown
 from recommonmark.parser import CommonMarkParser
@@ -69,8 +70,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'energy_demand'
-copyright = u'2017, Will Usher'
+project = u'energy_demand | MISTRAL'
+copyright = u'2017, Sven Eggimann'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -123,7 +124,10 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster' #classic, alabaster, default
+##html_theme = 'alabaster' #classic, alabaster, default
+import sphinx_rtd_theme
+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

diff --git a/docs/documentation_images/001-Supply_and_demand_overview.png b/docs/documentation_images/001-Supply_and_demand_overview.png
diff --git a/docs/documentation_images/002-constrained_optimised_modes.png b/docs/documentation_images/002-constrained_optimised_modes.png
diff --git a/docs/model_documentation.rst b/docs/model_documentation.rst
@@ -3,7 +3,7 @@
 Model Documentation
 ===============
 
-Model integration
+Overview
 -----------------
 
 The energy demand model of the ITRC-MISTRAL framework allows 
@@ -26,10 +26,22 @@ all ITRC models and provides demands to the supply model.
 
 Model integration
 -----------------
+#H1
+
+ttt
+
+##H2
+
+rsdrasdr
+
+###H3
+
+
+
+
 
-![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
 
-![Image of model integration](https://github.com/nismod/energy_demand/blob/master/docs/documentation_images/001-Supply_and_demand_overview.jpg)
+![Image of model integration](../documentation_images/001-Supply_and_demand_overview.png)
 
 
 
diff --git a/energy_demand/scripts_basic/__init__.py b/energy_demand/scripts_basic/__init__.py
@@ -0,0 +1 @@
+__all__ = []
diff --git a/energy_demand/scripts_validation/__init__.py b/energy_demand/scripts_validation/__init__.py
@@ -0,0 +1 @@
+__all__ = []
diff --git a/requirements.txt b/requirements.txt
@@ -8,4 +8,5 @@ scipy
 isoweek
 pyinstrument
 memprof
-autopep8
+autopep8
+sphinx_rtd_theme