From 8e914079c612bd2f0d77afe23697830fcfa2caf8 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 16 May 2020 09:44:30 +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.

Set openstackdocs_auto_name to use project as name.

Depends-On: https://review.opendev.org/728938
Change-Id: I11c609d70b7a020547b1897cce60a7a2365e7dd8
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          |  7 +++----
 lower-constraints.txt       |  4 ----
 releasenotes/source/conf.py | 11 ++++-------
 4 files changed, 10 insertions(+), 18 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 4252c22..a02f880 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,7 +2,7 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-openstackdocstheme>=1.18.1 # 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
 sphinxcontrib-apidoc>=0.2.0  # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 8966d75..cc1f2b7 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -24,15 +24,14 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/oslo.reports'
-bug_project = 'oslo.reports'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/oslo.reports'
+openstackdocs_bug_project = 'oslo.reports'
+openstackdocs_bug_tag = ''
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'oslo.reports'
 copyright = u'2014, OpenStack Foundation'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 3c4fa3c..3cd2900 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -23,7 +23,6 @@ mox3==0.20.0
 msgpack-python==0.4.0
 netaddr==0.7.18
 netifaces==0.10.4
-openstackdocstheme==1.18.1
 os-client-config==1.28.0
 oslo.config==5.2.0
 oslo.i18n==3.15.3
@@ -38,15 +37,12 @@ python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
 requests==2.14.2
 requestsexceptions==1.2.0
 rfc3986==0.3.1
 six==1.10.0
 smmap==0.9.0
 snowballstemmer==1.2.1
-Sphinx==1.8.0
-sphinxcontrib-websupport==1.0.1
 stestr==2.0.0
 stevedore==1.20.0
 testtools==2.2.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index bb24f46..ecb1002 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -40,9 +40,10 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/oslo.reports'
-bug_project = 'oslo.reports'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/oslo.reports'
+openstackdocs_bug_project = 'oslo.reports'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -145,10 +146,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