From 110a8ba12dfc15c80ef15d018ff941a70a769b11 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 30 May 2020 18:39:42 +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.

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

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6fb06892d..56f8df5ad 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,6 @@
 # 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.
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
-openstackdocstheme>=1.20.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4e6ace22b..6c80ce1dc 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -42,9 +42,10 @@ project = 'kuryr-kubernetes'
 copyright = '2013, OpenStack Foundation'
 
 # openstackdocstheme options
-repository_name = 'openstack/kuryr-kubernetes'
-bug_project = 'kuryr-kubernetes'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/kuryr-kubernetes'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'kuryr-kubernetes'
+openstackdocs_bug_tag = ''
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -54,7 +55,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'
 
 # -- Options for HTML output --------------------------------------------------
 
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 15906e981..d06c081ec 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -55,7 +55,6 @@ munch==2.2.0
 netaddr==0.7.19
 netifaces==0.10.6
 neutron-lib==1.13.0
-openstackdocstheme==1.20.0
 openstacksdk==0.36.0
 os-client-config==1.29.0
 os-service-types==1.7.0
@@ -104,7 +103,6 @@ python-neutronclient==6.7.0
 python-subunit==1.0.0
 pytz==2018.3
 PyYAML==3.12
-reno==2.5.0
 repoze.lru==0.7
 requests==2.18.0
 requestsexceptions==1.4.0
@@ -114,8 +112,6 @@ Routes==2.4.1
 setproctitle==1.1.10
 simplejson==3.13.2
 snowballstemmer==1.2.1
-Sphinx==1.6.2
-sphinxcontrib-websupport==1.0.1
 SQLAlchemy==1.2.5
 sqlalchemy-migrate==0.11.0
 sqlparse==0.2.4
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 6cf10aba4..04f2b3668 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -71,11 +71,16 @@ release = ''
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/kuryr-kubernetes'
+openstackdocs_bug_project = 'kuryr-kubernetes'
+openstackdocs_bug_tag = ''
+
 
 # -- Options for HTML output ----------------------------------------------