From 7ee77130c41b3e55b9e855bb886cd220b7787535 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Fri, 29 May 2020 12:45:06 +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: I5f985549671e3b4f8c438f247fae0818d25b21f5
---
 doc/source/conf.py          | 7 ++++---
 lower-constraints.txt       | 6 +++---
 releasenotes/source/conf.py | 7 ++++---
 requirements.txt            | 2 +-
 test-requirements.txt       | 4 ++--
 5 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 309847ab..b9c27b19 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -35,8 +35,9 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-repository_name = 'openstack/openstack-doc-tools'
-bug_tag = u'openstack-doc-tools'
+openstackdocs_repo_name = 'openstack/openstack-doc-tools'
+openstackdocs_auto_name = False
+openstackdocs_bug_tag = u'openstack-doc-tools'
 project = u'OpenStack-doc-tools'
 copyright = u'2017, OpenStack Foundation'
 
@@ -48,7 +49,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 1c634198..c125cb77 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -21,7 +21,7 @@ lxml==3.4.1
 MarkupSafe==1.0
 mccabe==0.2.1
 mock==2.0.0
-openstackdocstheme==1.20.0
+openstackdocstheme==2.2.1
 pbr==2.0.0
 pep8==1.5.7
 pyflakes==0.8.1
@@ -31,12 +31,12 @@ python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
+reno==3.1.0
 requests==2.14.2
 restructuredtext-lint==1.1.1
 six==1.10.0
 snowballstemmer==1.2.1
-Sphinx==1.8.0
+Sphinx==2.0.0
 sphinxcontrib-websupport==1.0.1
 stevedore==1.20.0
 stestr==2.0.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 89a67ec6..d17a0277 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -52,8 +52,9 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-repository_name = 'openstack/openstack-doc-tools'
-bug_tag = u'openstack-doc-tools'
+openstackdocs_repo_name = 'openstack/openstack-doc-tools'
+openstackdocs_auto_name = False
+openstackdocs_bug_tag = u'openstack-doc-tools'
 project = u'OpenStack-doc-tools Release Notes'
 copyright = u'2015-2017, OpenStack Documentation team'
 
@@ -93,7 +94,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/requirements.txt b/requirements.txt
index c893d129..157b9ba8 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -6,6 +6,6 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0
 iso8601>=0.1.11 # MIT
 lxml!=3.7.0,>=3.4.1 # BSD
 docutils>=0.11 # OSI-Approved Open Source, Public Domain
-sphinx>=1.8.0,!=2.1.0 # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 demjson>=2.2.2 # GLGPLv3+
 PyYAML>=3.12 # MIT
diff --git a/test-requirements.txt b/test-requirements.txt
index 8b716de8..990511da 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,8 +10,8 @@ doc8>=0.6.0 # Apache-2.0
 
 pylint==1.7.1 # GPLv2
 
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.20.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
 
 # mock object framework