From 4b0382070adf0c07e36e16ca868ee69ad55e9239 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 31 May 2020 20:36:21 +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: I0057fe10b462ce5ae430b9ad01e8f7d72be0f13a
---
 doc/source/conf.py          | 8 ++++----
 releasenotes/source/conf.py | 8 ++++----
 test-requirements.txt       | 6 +++---
 3 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0257d8c..1a01467 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -41,9 +41,9 @@ project = u'os-service-types'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = 'openstack/os-service-types'
-bug_project = '904'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/os-service-types'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -53,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 1fd580c..5a6fc84 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/os-service-types'
-bug_project = '904'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/os-service-types'
+openstackdocs_bug_project = '904'
+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 e4c2ccf..a97ed1a 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,13 +6,13 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 python-subunit>=1.0.0 # Apache-2.0/BSD
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2  # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 stestr>=2.0.0 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
 testscenarios>=0.4 # Apache-2.0/BSD
 requests-mock>=1.2.0 # Apache-2.0
-openstackdocstheme>=1.20.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 keystoneauth1>=3.4.0 # Apache-2.0
 # releasenotes
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 six>=1.10.0 # MIT