From ec5a9c99a8cb6936000c77305ae256a118f145f2 Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Tue, 27 Jun 2017 16:31:23 +0700 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: I305dc660e9f379f73b02e8d80c1999623ef92bab --- doc/source/conf.py | 7 ++++--- releasenotes/source/conf.py | 7 ++++--- test-requirements.txt | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 5237d2334..48d338410 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,6 +15,8 @@ import os import sys +import openstackdocstheme + sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- @@ -22,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -53,9 +54,9 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] -# html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' +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 14987ff2d..0a1281fd6 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -31,6 +31,8 @@ # -- General configuration ------------------------------------------------ +import openstackdocstheme + # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' @@ -38,7 +40,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', ] @@ -112,7 +113,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 @@ -120,7 +121,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 dc503268f..1e0c45914 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,7 +11,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 os-testr>=0.8.0 # Apache-2.0