From f86beabc4ce51fc0ed7d204feac423f9cba94cc4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 14:31:39 +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. Disable openstackdocs_auto_name to use 'project' variable as name. 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: I42c0fef8fe0bc4f0fc01cb0166081f5e2450d4e6 --- doc/requirements.txt | 6 +++--- releasenotes/source/conf.py | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index d3373815..44cb2082 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # This is required for the docs build jobs -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD -openstackdocstheme>=1.30.0 # 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>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 35c214b8..8eb7d5b8 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -86,7 +86,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 = [] @@ -250,6 +250,6 @@ texinfo_documents = [ locale_dirs = ['locale/'] # openstackdocstheme options -repository_name = 'openstack/puppet-barbican' -bug_project = 'puppet-barbican' -bug_tag = '' +openstackdocs_repo_name = 'openstack/puppet-barbican' +openstackdocs_bug_project = 'puppet-barbican' +openstackdocs_bug_tag = ''