From c76bbf87608ea6bc0e4923914b6ed43b61cc5a90 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 20:32:03 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I40a84c827397517b923158e5b8c57b21228b64b6 --- doc/requirements.txt | 6 +++--- releasenotes/source/conf.py | 13 +++++-------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index aa9dd6b2b..44cb2082b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # This is required for the docs build jobs -sphinx # BSD -openstackdocstheme # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 # This is required for the releasenotes build jobs -reno # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 415536f5b..15f60859e 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -87,7 +87,7 @@ exclude_patterns = [] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -136,10 +136,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. #html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True @@ -263,6 +259,7 @@ texinfo_documents = [ locale_dirs = ['locale/'] # openstackdocstheme options -repository_name = 'openstack/puppet-tripleo' -bug_project = 'puppet-tripleo' -bug_tag = '' +openstackdocs_repo_name = 'openstack/puppet-tripleo' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'puppet-tripleo' +openstackdocs_bug_tag = ''