From 2f60122b614152ca702f159927f6bf73a1b4363e Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Mon, 18 May 2020 21:48:11 +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.

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_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' as name.

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

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 1fdbb17cf..a7d55fa86 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,7 +1,7 @@
 # The order of packages is significant, because pip processes them in the order
 # 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
-reno>=2.5.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+openstackdocstheme>=2.2.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
 sphinxcontrib-apidoc>=0.2.0  # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0893ad437..684b31827 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -18,8 +18,9 @@ apidoc_separate_modules = True
 
 
 # openstackdocstheme options
-repository_name = 'openstack/python-ironicclient'
-use_storyboard = True
+openstackdocs_repo_name = 'openstack/python-ironicclient'
+openstackdocs_pdf_link = True
+openstackdocs_use_storyboard = True
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
diff --git a/lower-constraints.txt b/lower-constraints.txt
index ef7d3a994..f00f6a634 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -42,7 +42,6 @@ msgpack-python==0.4.0
 munch==2.1.0
 netaddr==0.7.18
 netifaces==0.10.4
-openstackdocstheme==1.20.0
 openstacksdk==0.18.0
 os-client-config==1.28.0
 os-service-types==1.2.0
@@ -79,7 +78,6 @@ python-openstackclient==3.12.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
 requests-mock==1.2.0
 requests==2.14.2
 requestsexceptions==1.2.0
@@ -87,8 +85,6 @@ restructuredtext-lint==1.1.1
 rfc3986==0.3.1
 simplejson==3.5.1
 snowballstemmer==1.2.1
-Sphinx==1.6.2
-sphinxcontrib-websupport==1.0.1
 stestr==1.0.0
 stevedore==1.20.0
 tempest==17.1.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 546befde0..991ee841d 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -43,9 +43,10 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/python-ironicclient'
-bug_project = 'python-ironicclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-ironicclient'
+openstackdocs_bug_project = 'python-ironicclient'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -148,10 +149,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