From a7a9f208650ba7a1f6ab0bf57a8ba33c96fd286c Mon Sep 17 00:00:00 2001 From: Shu Muto Date: Wed, 28 Jun 2017 12:21:51 +0900 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme As part of the docs migration work[0] for Pike we need to switch to use the openstackdocstheme. [0]https://review.openstack.org/#/c/472275/ Change-Id: I5de43845fdd29a8fc6eddb6564c20da2a47c6581 --- doc/source/conf.py | 6 +++--- releasenotes/source/conf.py | 7 ++++--- test-requirements.txt | 2 +- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 0033bbf..93bc96c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,6 +29,7 @@ import subprocess import sys import django +import openstackdocstheme BASE_DIR = os.path.dirname(os.path.abspath(__file__)) ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", "..")) @@ -173,7 +174,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'oslosphinx', ] # Add any paths that contain templates here, relative to this directory. @@ -244,8 +244,8 @@ nitpicky = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# html_theme_path = ['.'] -# html_theme = '_theme' +html_theme = 'openstackdocs' +html_theme_path = [openstackdocstheme.get_html_theme_path()] # 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 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 845ed45..ed9469f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -21,6 +21,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. +import openstackdocstheme + # 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. @@ -35,7 +37,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', ] @@ -109,7 +110,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 @@ -117,7 +118,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 = [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 7946c61..8580dc1 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -19,7 +19,7 @@ nose-exclude # LGPL nosehtmloutput>=0.0.3 # Apache-2.0 nosexcover # BSD openstack.nose-plugin>=0.7 # 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 selenium>=2.50.1 # Apache-2.0 sphinx>=1.6.2 # BSD