From 820a42650d0f1065434c826490699a050cf0b59e Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Mon, 1 Jun 2020 16:26:11 +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.

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.

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: I6e7b744bb8f56b0a237dc27da45635d99f3a0290
---
 doc/source/conf.py          | 9 +++++----
 releasenotes/source/conf.py | 9 +++++----
 test-requirements.txt       | 6 +++---
 3 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index ace41aa..34583bd 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -41,9 +41,10 @@ project = u'openstack'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/openstack'
-bug_project = 'zaqar_tempest_plugin'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/openstack'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'zaqar_tempest_plugin'
+openstackdocs_bug_tag = ''
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -53,7 +54,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/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 7a3054a..3aa870e 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -56,9 +56,10 @@ project = u'zaqar_tempest_plugin Release Notes'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/openstack'
-bug_project = 'zaqar_tempest_plugin'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/openstack'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'zaqar_tempest_plugin'
+openstackdocs_bug_tag = ''
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -100,7 +101,7 @@ exclude_patterns = []
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
diff --git a/test-requirements.txt b/test-requirements.txt
index f559c0e..6c8c1f4 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,10 +6,10 @@ hacking>=0.12.0,<0.13 # Apache-2.0
 
 coverage>=4.0,!=4.4 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx>=1.6.2 # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 oslotest>=1.10.0 # Apache-2.0
 testrepository>=0.0.18  # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
-openstackdocstheme>=1.11.0  # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 # releasenotes
-reno>=1.8.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0