From 5804a0f1e40f8c10c4cc9aab7d217f969beb3c35 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 28 May 2020 14:43:05 +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: I95a09d6ce195af3d483e170976f54353332bb190
---
 doc/requirements.txt  | 5 ++---
 doc/source/conf.py    | 7 ++++---
 lower-constraints.txt | 5 -----
 test-requirements.txt | 3 ---
 4 files changed, 6 insertions(+), 14 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 4d7c9a38..4449d991 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,5 @@
 # this is required for the docs build jobs
-sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
-sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
-openstackdocstheme>=1.20.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 doc8>=0.8.0 # Apache-2.0
 sphinxcontrib-apidoc>=0.2.0  # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7e7d28cb..91a68c22 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -15,8 +15,9 @@ apidoc_separate_modules = True
 
 
 # openstackdocstheme options
-repository_name = 'openstack/validations-libs'
-use_storyboard = True
+openstackdocs_repo_name = 'openstack/validations-libs'
+openstackdocs_pdf_link = True
+openstackdocs_use_storyboard = True
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -45,7 +46,7 @@ add_function_parentheses = True
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of glob-style patterns that should be excluded when looking for
 # source files. They are matched against the source file names relative to the
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 37036a4e..abc6a65c 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -51,7 +51,6 @@ msgpack==0.5.6
 munch==2.2.0
 netaddr==0.7.18
 netifaces==0.10.6
-openstackdocstheme==1.20.0
 openstacksdk==0.24.0
 os-client-config==1.29.0
 os-net-config==7.1.0
@@ -94,7 +93,6 @@ python-swiftclient==3.5.0
 python-zaqarclient==1.9.0
 pytz==2018.3
 PyYAML==3.12
-reno==2.5.0
 requests==2.18.4
 requestsexceptions==1.4.0
 rfc3986==1.1.0
@@ -102,9 +100,6 @@ simplejson==3.13.2
 six==1.11.0
 smmap2==2.0.3
 snowballstemmer==1.2.1
-Sphinx==1.8.0
-sphinxcontrib-apidoc==0.2.0
-sphinxcontrib-websupport==1.0.1
 stestr==1.0.0
 stevedore==1.28.0
 tenacity==5.0.1
diff --git a/test-requirements.txt b/test-requirements.txt
index 0d58bb5c..eaa8652c 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -2,13 +2,10 @@
 # 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
 hacking>=3.0,<3.1.0 # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 python-subunit>=1.0.0 # Apache-2.0/BSD
-sphinx>=1.8.0,!=2.1.0 # BSD
-sphinxcontrib-apidoc>=0.2.0  # BSD
 stestr>=1.0.0 # Apache-2.0
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT