From b7a0cd0e66ac07944a80a60232ad39e5de6555e0 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 16 Jun 2017 15:29:01 -0400 Subject: [PATCH] switch to openstackdocstheme Change-Id: Id687e3405d8afe0db201eb648941cc51bb9f741e Signed-off-by: Doug Hellmann --- doc/source/conf.py | 13 ++++++++++++- releasenotes/source/conf.py | 6 ++++-- test-requirements.txt | 2 +- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 00560742..4185e4b4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,6 +16,8 @@ import os import sys +import openstackdocstheme + sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) @@ -23,7 +25,7 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), # 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', 'oslosphinx'] +extensions = ['sphinx.ext.autodoc'] # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -54,6 +56,15 @@ pygments_style = 'sphinx' # -- Options for HTML output -------------------------------------------------- +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +#html_theme = 'nature' +html_theme = 'openstackdocs' + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = ['_theme'] +html_theme_path = [openstackdocstheme.get_html_theme_path()] + # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 01beeaa0..0e270c70 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,6 +29,8 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) +import openstackdocstheme + # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -38,7 +40,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', ] @@ -113,7 +114,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 = 'openstackdocs' # 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 @@ -122,6 +123,7 @@ html_theme = 'default' # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] +html_theme_path = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/test-requirements.txt b/test-requirements.txt index 97ea6444..c08fe4d1 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,7 +7,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 mock>=2.0 # BSD ordereddict # MIT os-client-config>=1.27.0 # Apache-2.0 -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0 sphinx>=1.6.2 # BSD testrepository>=0.0.18 # Apache-2.0/BSD