From 6e7d0123eca58b857927920c33ba01ebbeba6821 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 20:36:49 +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: I5aedf5a96bc39825dac6b0ddd0005c9e8e0b1619 --- doc/source/conf.py | 7 ++++--- releasenotes/source/conf.py | 7 ++++--- test-requirements.txt | 6 +++--- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index fdcac593d..b45efff3f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -239,6 +239,7 @@ texinfo_documents = [ # texinfo_no_detailmenu = False # openstackdocstheme options -repository_name = 'openstack/tripleo-image-elements' -bug_project = 'tripleo' -bug_tag = 'documentation' +openstackdocs_repo_name = 'openstack/tripleo-image-elements' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'tripleo' +openstackdocs_bug_tag = 'documentation' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 8f2ccc602..cc9829374 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -261,6 +261,7 @@ texinfo_documents = [ locale_dirs = ['locale/'] # openstackdocstheme options -repository_name = 'openstack/tripleo-image-elements' -bug_project = 'tripleo' -bug_tag = 'documentation' +openstackdocs_repo_name = 'openstack/tripleo-image-elements' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'tripleo' +openstackdocs_bug_tag = 'documentation' diff --git a/test-requirements.txt b/test-requirements.txt index 3687e2d8a..e0a95edb7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,7 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0 -openstackdocstheme>=1.11.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 oslotest -sphinx>=1.8.0,!=2.1.0 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD testrepository>=0.0.18 -reno>=1.8.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0