Switch sphinx theme from alabaster to sphinx_rtd_theme

heremaps · Sep 1, 2020 · a2aaa9c · a2aaa9c
1 parent 01ed10c
commit a2aaa9c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/docs/apiref/conf.py b/docs/apiref/conf.py
@@ -32,7 +32,8 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinx.ext.todo',
-    'sphinx.ext.autodoc.typehints'
+    'sphinx.ext.autodoc.typehints',
+    'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,7 +57,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/apiref/index.rst b/docs/apiref/index.rst
@@ -3,8 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to xyzspaces's documentation!
-=====================================
+Documentation for xyzspaces
+===========================
+
+At the moment this consists only of this API reference which is automatically
+generated from the source code. Apart from this there are Jupyter notebooks
+to get started with some examples. A more prosaic documentation will hopefully
+follow, soon.
 
 .. toctree::
    :maxdepth: 4