From 774d995b7fc6533a98a5765589c6304ed7093b4d Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Tue, 4 Jul 2017 01:10:43 +0000 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme Change-Id: I1aecf894955e8095c11b8fb82d60488e5d0aca5f --- doc/source/conf.py | 14 ++++++++++---- releasenotes/source/conf.py | 9 +++++++-- test-requirements.txt | 2 +- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e78556f46..63101b8a6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.httpdomain', 'sphinxcontrib.pecanwsme.rest', 'wsmeext.sphinxext', - 'oslosphinx', + 'openstackdocstheme', ] wsme_protocols = ['restjson'] @@ -66,9 +66,15 @@ suppress_warnings = ['app.add_directive'] # 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' + +# openstackdocstheme options +repository_name = 'openstack/ironic-python-agent' +bug_project = 'ironic-python-agent' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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 8e77d0ab7..56d5306ea 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -112,7 +112,12 @@ 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' + +# openstackdocstheme options +repository_name = 'openstack/ironic-python-agent' +bug_project = 'ironic-python-agent' +bug_tag = '' # 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/test-requirements.txt b/test-requirements.txt index 36c4e8060..0d284a57a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -15,5 +15,5 @@ flake8-import-order==0.11 # LGPLv3 doc8 # Apache-2.0 sphinx>=1.6.2 # BSD sphinxcontrib-pecanwsme>=0.8 # 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