X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=baf787e31df7d587fe990fb203b81f8777aba941;hb=d124b9dd0399843680c16420e06fdf358e5ff401;hp=7ac6e2afb03c6034e3def7540d212c2f217ee608;hpb=839939c0d080dfe1c3adeee1e6565aac13c545bf;p=dunshire.git diff --git a/doc/source/conf.py b/doc/source/conf.py index 7ac6e2a..baf787e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -7,21 +7,24 @@ import shlex # 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('../../src/')) -sys.path.insert(0, os.path.abspath('../../src/dunshire')) +sys.path.insert(0, os.path.abspath('../../')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. 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: @@ -71,10 +74,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 +104,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'