From e367b6270c6d544312817ab31723aae54f4c234a Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 2 Jun 2020 19:01:07 +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.

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.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4418f86c3066353d43758118865baf66d1741c79
---
 doc/requirements.txt        |  4 ++--
 doc/source/conf.py          | 10 ++++++----
 lower-constraints.txt       |  4 ----
 releasenotes/source/conf.py |  6 +++---
 4 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 5700e3b1..6894ce18 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
 keystoneauth1>=3.4.0  # Apache-2.0
 sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0  # BSD
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.31.2 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 5f88f5ac..83816050 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -55,6 +55,12 @@ master_doc = 'index'
 # General information about the project.
 copyright = u'2013-2016 OpenStack, LLC.'
 
+# -- Options for openstackdocstheme -------------------------------------------
+openstackdocs_repo_name = 'openstack/python-swiftclient'
+openstackdocs_bug_project = 'python-swiftclient'
+openstackdocs_bug_tag = ''
+openstackdocs_pdf_link = True
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None
@@ -131,10 +137,6 @@ html_theme_options = {'show_other_versions': True}
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 1e4ffb90..28a10600 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -20,7 +20,6 @@ MarkupSafe==1.0
 mccabe==0.2.1
 mock==1.2.0
 netaddr==0.7.10
-openstackdocstheme==2.0.0
 openstacksdk==0.11.0
 oslo.config==1.2.0
 pbr==2.0.0
@@ -33,12 +32,9 @@ python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
 requests==1.1.0
 six==1.9.0
 snowballstemmer==1.2.1
-sphinx==2.0.0
-sphinxcontrib-websupport==1.0.1
 stestr==2.0.0
 testtools==2.2.0
 traceback2==1.4.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 9bdbbe40..a050a546 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -339,6 +339,6 @@ htmlhelp_basename = 'SwiftClientReleaseNotesdoc'
 locale_dirs = ['locale/']
 
 # -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/python-swiftclient'
-bug_project = 'python-swiftclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-swiftclient'
+openstackdocs_bug_project = 'python-swiftclient'
+openstackdocs_bug_tag = ''