From 69f4b79813533333ac968ddca372d9e3b9b98356 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 30 May 2020 16:44:11 +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.

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: I10e31a8883739e8844b9d974cf4da62cfc28efe0
---
 api-ref/source/conf.py | 9 +++++----
 doc/requirements.txt   | 4 ++--
 doc/source/conf.py     | 9 +++++----
 lower-constraints.txt  | 3 ---
 4 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index 1e3c08c3..6a0d93bc 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -39,9 +39,10 @@ html_theme_options = {
     "sidebar_mode": "toc",
 }
 # openstackdocstheme options
-repository_name = 'openstack/ec2-api'
-bug_project = 'ec2-api'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/ec2-api'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'ec2-api'
+openstackdocs_bug_tag = ''
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -107,7 +108,7 @@ add_module_names = False
 show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # -- Options for man page output ----------------------------------------------
 
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 8c8fbbd3..5a6776d6 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,6 +2,6 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-sphinx>=1.8.0,!=2.1.0 # BSD
-openstackdocstheme>=1.31.2 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 os-api-ref>=1.5.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 9ba0b378..7073afce 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -23,9 +23,10 @@ extensions = ['sphinx.ext.doctest',
               'openstackdocstheme']
 
 # openstackdocstheme options
-repository_name = 'openstack/ec2-api'
-bug_project = 'ec2-api'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/ec2-api'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'ec2-api'
+openstackdocs_bug_tag = ''
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -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/lower-constraints.txt b/lower-constraints.txt
index 6469c921..a848a28f 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -49,7 +49,6 @@ munch==2.2.0
 netaddr==0.7.19
 netifaces==0.10.6
 nose==1.3.7
-openstackdocstheme==1.31.2
 openstacksdk==0.12.0
 os-api-ref==1.5.0
 os-client-config==1.29.0
@@ -98,8 +97,6 @@ Routes==2.4.1
 simplejson==3.13.2
 six==1.11.0
 snowballstemmer==1.2.1
-Sphinx==1.8.0
-sphinxcontrib-websupport==1.0.1
 SQLAlchemy==1.2.5
 sqlalchemy-migrate==0.11.0
 sqlparse==0.2.4