From 9a1193ba182df69f073f0ace478fe82e35f0d25e Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 2 Jun 2020 14:04:01 +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: I1d291a4755a86ef2564a675eaa25b6d98585b610
---
 doc/requirements.txt        | 6 +++---
 doc/source/conf.py          | 7 ++++---
 lower-constraints.txt       | 2 +-
 releasenotes/source/conf.py | 7 ++++---
 test-requirements.txt       | 2 +-
 5 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 32f3ac5d9..d7b5677e7 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,7 +2,7 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 oslo.config>=5.2.0 # Apache-2.0
-openstackdocstheme>=1.31.2 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
-reno>=2.7.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+reno>=3.1.0 # Apache-2.0
 docutils>=0.11  # OSI-Approved Open Source, Public Domain
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7e689a1ea..f8c91dcdf 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -57,7 +57,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 --------------------------------------------------
 
@@ -69,8 +69,9 @@ html_static_path = ['_static']
 html_theme = 'openstackdocs'
 
 # openstackdocstheme options
-repository_name = 'openstack/vitrage'
-use_storyboard = True
+openstackdocs_repo_name = 'openstack/vitrage'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 056804c37..e5ba65f59 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -104,7 +104,7 @@ python-troveclient==2.2.0
 pytz==2013.6
 PyYAML==3.12
 pyzabbix==0.7.4
-reno==2.7.0
+reno==3.1.0
 repoze.lru==0.7
 requests==2.18.4
 requests-mock==1.4.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 9f8e19805..0f1e018bc 100755
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -38,8 +38,9 @@ project = u'vitrage releasenotes'
 copyright = u'2016, Vitrage developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/vitrage'
-use_storyboard = True
+openstackdocs_repo_name = 'openstack/vitrage'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -49,7 +50,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/test-requirements.txt b/test-requirements.txt
index 24e2eceae..2a9084b13 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,5 +10,5 @@ requests-mock>=1.4.0 # Apache-2.0
 testscenarios>=0.5.0 # Apache-2.0/BSD
 testtools>=2.3.0 # MIT
 stestr>=2.0.0 # Apache-2.0
-reno>=2.7.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 zake>=0.1.6 # Apache-2.0