readthedocs configuration

.readthedocs.yml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  image: latest
+
+formats: all
+
+python:
+  version: 3.6
+  install:
+           - requirements: requirements.txt
+           - requirements: docs/requirements.txt
+           - method: setuptools
+

docs/requirements.txt

@@ -1 +1,2 @@
-numpydoc
+numpydoc
+sphinx_rtd_theme

docs/source/conf.py

@@ -7,6 +7,7 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
 sys.path.insert(0, os.path.abspath('../../'))
 
 import elegant
@@ -24,7 +25,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
+    'sphinx_rtd_theme',
     'numpydoc',
 ]
 
@@ -71,17 +72,16 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-todo_include_todos = True
+todo_include_todos = False
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'neo_rtd_theme'
-import sphinx_theme
-html_theme_path = [sphinx_theme.get_html_theme_path()]
+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
@@ -166,7 +166,7 @@
 
 
 
-# intersphinx enables links to classes/functions in the packages defined here:
+# Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'python': ('https://docs.python.org/3/', None),
                        'numpy': ('https://docs.scipy.org/doc/numpy/', None),
                        'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),

docs/source/index.rst

@@ -1,6 +1,6 @@
-====
+=======
 elegant
-====
+=======
 
 ``elegant`` is a Pure Python Power Systems Simulator.
 The latest development version can be found `here <https://github.com/dioph/aspy>`_.