From 620c6689e92c36f27b3fa490b123353ea45b8a3a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger <aj@suse.com> Date: Sat, 16 May 2020 09:40:45 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.0 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. 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. Depends-On: https://review.opendev.org/728938 Change-Id: Idc8d870e5c12e18efd07427eb1772d0f4e65d262 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 6 +++--- releasenotes/source/conf.py | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 7dcf079..0ece746 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,7 +3,7 @@ # process, which may cause wedges in the gate later. # These are needed for docs generation -openstackdocstheme>=1.31.2 # Apache-2.0 -sphinx>=1.8.0,!=2.1.0 # BSD -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 44499e2..af15cf7 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,9 +29,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.middleware' -bug_project = 'oslo.middleware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.middleware' +openstackdocs_bug_project = 'oslo.middleware' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 7445297..9db72e4 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -39,9 +39,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.middleware' -bug_project = 'oslo.middleware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.middleware' +openstackdocs_bug_project = 'oslo.middleware' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']