From 558863620f47e0126c22efc712f59faee01a451b Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Sun, 2 Jul 2017 13:31:19 +0800 Subject: [PATCH] Fix openstackdocstheme See the docs[0] how to use it. Also add the variables for the bug log feature. [0]https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: I48211b9c23d188c4033868603f96e1a3cd4156ae --- releasenotes/source/conf.py | 14 +++++++++----- test-requirements.txt | 4 ++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index c27aa296..238c1248 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -20,7 +20,6 @@ # -- General configuration ------------------------------------------------ -import openstackdocstheme # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' @@ -29,6 +28,7 @@ import openstackdocstheme # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'openstackdocstheme', 'reno.sphinxext', ] @@ -105,11 +105,10 @@ 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 # documentation. -#html_theme_options = {} +# 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()] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -139,7 +138,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -262,3 +261,8 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# openstackdocstheme options +repository_name = 'openstack/puppet-aodh' +bug_project = 'puppet-aodh' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index 31c3f5ad..a23c7e73 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,6 +1,6 @@ # This is required for the docs build jobs -sphinx!=1.6.1,>=1.5.1 # BSD -openstackdocstheme>=1.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 # This is required for the releasenotes build jobs # FIXME: reno is manually pinned to !=2.0.0 because of bug #1651995