From 9232f14ea199acc6620c666e9cc0567c314bac15 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Mon, 1 Jun 2020 16:27:45 +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_version to not auto-version the documents.

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

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 6ae7c95..0fd5f71 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -40,9 +40,10 @@ project = u'zun-tempest-plugin'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/zun-tempest-plugin'
-bug_project = 'zun'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/zun-tempest-plugin'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'zun'
+openstackdocs_bug_tag = ''
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -52,7 +53,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 cb42889..0b5afef 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -55,9 +55,9 @@ master_doc = 'index'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/zun_tempest_plugin'
-bug_project = 'zun'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/zun_tempest_plugin'
+openstackdocs_bug_project = 'zun'
+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
@@ -99,7 +99,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 b18a222..35a0645 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,7 +5,7 @@
 hacking>=3.0.1,<3.1.0;python_version>='3.5' # Apache-2.0
 
 sphinx>=2.0.0,!=2.1.0 # BSD
-openstackdocstheme>=2.0.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 # releasenotes
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 doc8>=0.6.0 # Apache-2.0