From bd3252f1c70eed7e3960e105771599f95dac7ba5 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Thu, 5 Nov 2015 14:50:42 +1100 Subject: [PATCH] Use Sphinx Cloud theme for docs. --- dev-requirements.txt | 1 + docs/conf.py | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/dev-requirements.txt b/dev-requirements.txt index 1a5df70..101a9b6 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,4 +1,5 @@ -r requirements.txt Sphinx==1.3.1 Sphinx-PyPI-upload==0.2.1 +cloud_sptheme==1.7 twine==1.6.4 diff --git a/docs/conf.py b/docs/conf.py index 21b7646..49b1a11 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,8 @@ import sys import os +import cloud_sptheme as csp + # 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. @@ -33,6 +35,8 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', + 'cloud_sptheme.ext.index_styling', + 'cloud_sptheme.ext.relbar_toc', ] # Add any paths that contain templates here, relative to this directory. @@ -103,15 +107,17 @@ 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 = 'cloud' # 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_options = { + 'max_width': '80em', +} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [csp.get_theme_dir()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation".