From bd2c3f500abb6d27ad31710e6bed20dcc1a556a0 Mon Sep 17 00:00:00 2001 From: Ewen Cheslack-Postava Date: Thu, 12 May 2016 11:25:23 -0700 Subject: [PATCH 1/2] Use ReadTheDocs theme for building docs. --- docs/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3d78ca9df..6222457ec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,14 +100,16 @@ # -- Options for HTML output ---------------------------------------------- +import sphinx_rtd_theme + # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # 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 # documentation. -#html_theme_options = {} +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] From b1c85629eca8ef41e262c540e4488eb62d60fadf Mon Sep 17 00:00:00 2001 From: Ewen Cheslack-Postava Date: Thu, 12 May 2016 11:40:29 -0700 Subject: [PATCH 2/2] Update README instructions for building docs. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a9470f581..578679b76 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ Run integration tests Generate documentation ====================== +Install sphinx and sphinx_rtd_theme packages and then: make docs