From 9cc3f52ac3950189cd87aee3b91b195023291f8d Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 16 May 2020 09:34:40 +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

Update Sphinx version as well.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: I70c7edf8b95cde890e6263195be1de6bb826e700
---
 doc/requirements.txt        | 6 +++---
 doc/source/conf.py          | 6 +++---
 lower-constraints.txt       | 4 ----
 releasenotes/source/conf.py | 6 +++---
 4 files changed, 9 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index c60c647a7..fe166fd99 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,9 +2,9 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-openstackdocstheme>=1.20.0 # 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
 
 # imported when the source code is parsed for generating documentation:
 fixtures>=3.0.0 # Apache-2.0/BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index c68ede84d..17431483b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -25,9 +25,9 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/oslo.messaging'
-bug_project = 'oslo.messaging'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/oslo.messaging'
+openstackdocs_bug_project = 'oslo.messaging'
+openstackdocs_bug_tag = ''
 
 # The master toctree document.
 master_doc = 'index'
diff --git a/lower-constraints.txt b/lower-constraints.txt
index b67442e30..de22f0724 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -36,7 +36,6 @@ mox3==0.20.0
 msgpack-python==0.4.0
 netaddr==0.7.18
 netifaces==0.10.4
-openstackdocstheme==1.20.0
 os-client-config==1.28.0
 oslo.concurrency==3.25.0
 oslo.config==5.2.0
@@ -67,7 +66,6 @@ python-qpid-proton==0.17.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
 repoze.lru==0.7
 requests==2.14.2
 requestsexceptions==1.2.0
@@ -76,8 +74,6 @@ Routes==2.3.1
 six==1.10.0
 smmap==0.9.0
 snowballstemmer==1.2.1
-Sphinx==1.8.0
-sphinxcontrib-websupport==1.0.1
 statsd==3.2.1
 stestr==2.0.0
 stevedore==1.20.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index e8b21ac99..f84717078 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -46,9 +46,9 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/oslo.messaging'
-bug_project = 'oslo.messaging'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/oslo.messaging'
+openstackdocs_bug_project = 'oslo.messaging'
+openstackdocs_bug_tag = ''
 
 # The master toctree document.
 master_doc = 'index'