From be7dc8aa490ae826710dbccaff6ab5640428c64e Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 2 Jun 2020 14:20:42 +0200
Subject: [PATCH] Switch to newer openstackdocstheme version

Switch to openstackdocstheme 2.2.1 version. Using
this version 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: I0d5889f8f4a846e06c1fdcb69c603c6a4c0b8ba0
---
 doc/source/conf.py | 8 ++++++--
 requirements.txt   | 4 ++--
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index a54df49..2f271a7 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -36,7 +36,7 @@ extensions = [
              ]
 
 # Feed configuration for yasfb
-feed_base_url = 'http://specs.openstack.org/openstack/qa-specs'
+feed_base_url = 'https://specs.openstack.org/openstack/qa-specs'
 feed_author = 'OpenStack QA Team'
 
 # Optionally allow the use of sphinxcontrib.spelling to verify the
@@ -65,6 +65,10 @@ master_doc = 'index'
 project = u'QA Specs'
 copyright = u'%s, OpenStack QA Team' % datetime.date.today().year
 
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/qa-specs'
+openstackdocs_auto_name = False
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -97,7 +101,7 @@ add_module_names = False
 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 = ['qa-specs.']
diff --git a/requirements.txt b/requirements.txt
index 68b33c6..3e043d1 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,5 +1,5 @@
 pbr>=1.6  # Apache-2.0
 docutils>=0.11,!=0.13.1  # OSI-Approved Open Source, Public Domain
-sphinx>=1.6.2  # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 yasfb>=0.5.1
-openstackdocstheme>=1.31.2 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0