From a1466466aecef7ed3661615b4b8a5525a625f3d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 10 Oct 2014 23:26:15 +0200 Subject: [PATCH] switch to the rtd theme --- README.md | 1 + source/conf.py | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60b134289..a1b361b41 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Compilation into HTML To compile this documentation : 1. Install [sphinx-doc](http://sphinx-doc.org) +2. Install the Sphinx theme provided by Read the Docs : `sudo pip install sphinx_rtd_theme` 2. run `make html` from the root directory 3. The base file is located on build/html/index.html diff --git a/source/conf.py b/source/conf.py index 517f70a82..e365b8215 100644 --- a/source/conf.py +++ b/source/conf.py @@ -15,6 +15,7 @@ import sys import os +import sphinx_rtd_theme # 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 @@ -102,7 +103,7 @@ pygments_style = 'sphinx' # 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 @@ -110,7 +111,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation".