Switch to Mathjax for the docs and finish the "Background" section.

[dunshire.git] / doc / source / conf.py

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7ac6e2afb03c6034e3def7540d212c2f217ee608..d6752551eabcdd8a8bc9d389b83bfe47a847b3fa 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -16,13 +16,20 @@ sys.path.insert(0, os.path.abspath('../../src/dunshire'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
-    'sphinx.ext.coverage',
-    'sphinx.ext.ifconfig',
+    'sphinx.ext.doctest',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
 ]
 
 autosummary_generate = True
 
+# Don't automatically test every >>> block in the documentation. This
+# avoids testing the API docs as part of the documentation build,
+# which is exactly what we intend, because those are tested as part of
+# the (much faster) unittest test suite.
+doctest_test_doctest_blocks = ''
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
@@ -71,10 +78,18 @@ html_theme = 'alabaster'
 
 # Remove the search box from the default list of sidebars.
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html'
-    ]
+  '**': [
+    'about.html',
+    'navigation.html'
+  ]
+}
+
+# http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
+html_theme_options = {
+  'github_button': False,
+  'github_user': False,
+  'github_repo': False,
+  'show_powered_by': False
 }
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
@@ -93,12 +108,6 @@ html_show_copyright = False
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = None
 
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
-#html_search_language = 'en'
-
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
 #html_search_scorer = 'scorer.js'