From e662da0d5751da52bc9c269bb8df7ba470c2b002 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Wed, 3 Jun 2020 20:25:27 +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: I13e5de067ad381d058060bc5e297a0360804e119
---
 doc/requirements.txt        | 4 ++--
 doc/source/conf.py          | 9 +++++----
 releasenotes/source/conf.py | 8 +++++++-
 test-requirements.txt       | 2 +-
 4 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 7208af68..eccc937c 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,2 +1,2 @@
-sphinx>=2.0.0  # BSD
-openstackdocstheme>=2.0.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 508cef87..494fe22f 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -26,9 +26,10 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/os-net-config'
-bug_project = 'os-net-config'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/os-net-config'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'os-net-config'
+openstackdocs_bug_tag = ''
 html_theme = 'openstackdocs'
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -53,7 +54,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 384b0971..1c1b6720 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -58,6 +58,12 @@ master_doc = 'index'
 project = u'os-net-config Release Notes'
 copyright = u'2018, OpenStackFoundation'
 
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/os-net-config'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'os-net-config'
+openstackdocs_bug_tag = ''
+
 # Release notes are version independent
 # The full version, including alpha/beta/rc tags.
 release = ''
@@ -94,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 = []
diff --git a/test-requirements.txt b/test-requirements.txt
index 8fa262d2..35c208b4 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -9,4 +9,4 @@ python-subunit>=0.0.18 # Apache-2.0/BSD
 stestr>=2.0.0 # Apache-2.0
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0