From cbfa8bf76edc74affd33e0fdb065d17fa02644e3 Mon Sep 17 00:00:00 2001 From: Yumeng_Bao Date: Tue, 11 Jul 2017 11:22:26 +0800 Subject: [PATCH] switch to openstackdocstheme Change-Id: I71aac9c5e629e88fa8009ce4b303c658c3e37fd2 Co-Authored-By: chenxing --- doc/source/conf.py | 16 +++++++++++++--- releasenotes/source/conf.py | 15 ++++++++++++--- test-requirements.txt | 4 ++-- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 6b5d965..4d8bb80 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -18,7 +18,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', - 'oslosphinx', + 'openstackdocstheme', ] wsme_protocols = ['restjson'] @@ -35,7 +35,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Watcher' +project = u'Watcher Dashboard' copyright = u'OpenStack Foundation' # The version info for the project you're documenting, acts as replacement for @@ -84,7 +84,9 @@ man_pages = [] # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] -html_theme_options = {'incubating': True} +# html_theme_options = {'incubating': True} +# html_theme_options = {"show_other_versions": "True"} +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project @@ -101,3 +103,11 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. # intersphinx_mapping = {'http://docs.python.org/': None} + +# openstackdocstheme options +repository_name = 'openstack/watcher-dashboard' +bug_project = 'watcher-dashboard' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index bfe086f..0d47980 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -37,7 +37,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -111,12 +111,21 @@ 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/watcher-dashboard' +bug_project = 'watcher-dashboard' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # 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 # documentation. -# html_theme_options = {} +# html_theme_options = {"show_other_versions": "True"} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] diff --git a/test-requirements.txt b/test-requirements.txt index d89c6d4..6ca32cd 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -21,6 +21,6 @@ testtools>=1.4.0 # MIT xvfbwrapper>=0.1.3 #license: MIT # Doc requirements -oslosphinx>=4.7.0 # Apache-2.0 -sphinx!=1.6.1,>=1.5.1 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 +sphinx>=1.6.2 # BSD reno>=1.8.0 # Apache-2.0