From 7662a4403d9b1c7b4445c66cc1bfdc863a40ca4c Mon Sep 17 00:00:00 2001 From: zhengwei6082 Date: Mon, 28 Aug 2017 14:02:08 +0800 Subject: [PATCH] Switch from oslosphinx to openstackdocstheme To use openstackdocstheme 1.11.0 properly, this patch fixes some settings according to follow. https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: I1d3dee2bb7b5de8abc110d1609b9b41bd363f802 --- releasenotes/source/conf.py | 13 +++++++++++-- test-requirements.txt | 4 ++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 9c403608..c3924060 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,7 +29,7 @@ import os # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -41,6 +41,15 @@ templates_path = ['_templates'] # source_suffix = ['.rst', '.md'] source_suffix = '.rst' +# openstackdocstheme options +repository_name = 'openstack/trove-dashboard' +bug_project = 'trove-dashboard' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + + # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -112,7 +121,7 @@ todo_include_todos = False # 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 diff --git a/test-requirements.txt b/test-requirements.txt index 5425992f..7c8c0994 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,8 +10,8 @@ mock>=1.2 mox3>=0.7.0 python-subunit>=0.0.18 selenium -sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 -oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 testrepository>=0.0.18 testscenarios>=0.4 testtools>=1.4.0