From 6e7b87c77649cb9ef93dfe158076a2a6767ba579 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 23 Jun 2017 12:55:01 -0400 Subject: [PATCH] switch from oslosphinx to openstackdocstheme Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb Change-Id: I890bc443bf07a4570c907668288176ff2411e4ed Signed-off-by: Doug Hellmann --- doc/source/conf.py | 10 +++++++--- releasenotes/source/conf.py | 6 ++++-- test-requirements.txt | 2 +- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index f64b726d..9d2afeeb 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,10 +24,15 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', #'sphinx.ext.intersphinx', - 'oslosphinx', 'oslo_config.sphinxext', + 'openstackdocstheme', ] +# openstackdocstheme options +repository_name = 'openstack/oslo.log' +bug_project = 'oslo.log' +bug_tag = '' + # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -56,9 +61,8 @@ 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' # 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 2a57182f..0c950ffd 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', ] @@ -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 @@ -121,6 +122,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 4b2b26c1..647dc11a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,7 +17,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 # this is required for the docs build jobs sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0 # Bandit security code scanner