From 56023326cbfa8d45d507705f0a58b8e3bc6a1ff1 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 31 May 2020 20:43:02 +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: I4ace84f37b5814a54c130f6601baa2275a10d906
---
 doc/requirements.txt        | 7 +++----
 doc/source/conf.py          | 7 +++----
 releasenotes/source/conf.py | 9 ++++-----
 3 files changed, 10 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index c0de37b22..56f8df5ad 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,7 +1,6 @@
 # The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
-sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7'  # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
-openstackdocstheme>=1.18.1 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 780d764a5..f441ebc41 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -10,10 +10,9 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/shade'
-bug_project = '760'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = 'openstack/shade'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 html_theme = 'openstackdocs'
 
 # The suffix of source filenames.
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index e813fcf9f..321322170 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -43,10 +43,9 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/shade'
-bug_project = '760'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = 'openstack/shade'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -101,7 +100,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 = []