From f108b7a2d0dcbe107935f979f1d2a73fba90577d Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 21 May 2020 14:36:15 +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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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.
This repo uses storyboard, configure the proper variables.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Id084bfc9d5ae7a95d3cba22a00b4c03a35967ee4
---
 doc/source/conf.py          | 10 +++++-----
 lower-constraints.txt       |  6 +++---
 releasenotes/source/conf.py |  8 ++++----
 test-requirements.txt       |  6 +++---
 4 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index ac6c2ec0d..15feefce8 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -34,7 +34,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 --------------------------------------------------
@@ -44,12 +44,12 @@ pygments_style = 'sphinx'
 html_theme = 'openstackdocs'
 
 # openstackdocstheme options
-repository_name = 'openstack/ironic-python-agent'
-bug_project = 'ironic-python-agent'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/ironic-python-agent'
+openstackdocs_pdf_link = True
+openstackdocs_use_storyboard = True
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Ironic Python Agentdoc' 
+htmlhelp_basename = 'Ironic Python Agentdoc'
 
 latex_use_xindy = False
 
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 958727eac..54a9fd53f 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -36,7 +36,7 @@ mox3==0.25.0
 msgpack-python==0.5.6
 netaddr==0.7.19
 netifaces==0.10.4
-openstackdocstheme==1.20.0
+openstackdocstheme==2.2.1
 os-client-config==1.29.0
 oslo.concurrency==3.26.0
 oslo.config==5.2.0
@@ -64,7 +64,7 @@ python-subunit==1.2.0
 pytz==2018.3
 pyudev==0.18
 PyYAML==3.12
-reno==2.5.0
+reno==3.1.0
 repoze.lru==0.7
 requests==2.14.2
 requestsexceptions==1.4.0
@@ -75,7 +75,7 @@ rtslib-fb==2.1.65
 six==1.14.0
 smmap==3.0.2
 snowballstemmer==1.2.1
-Sphinx==1.6.2
+Sphinx==2.0.0
 sphinxcontrib-websupport==1.0.1
 stestr==1.0.0
 stevedore==1.20.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 36d3e85b9..aec5c02c3 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -95,7 +95,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 = []
@@ -111,9 +111,9 @@ pygments_style = 'sphinx'
 html_theme = 'openstackdocs'
 
 # openstackdocstheme options
-repository_name = 'openstack/ironic-python-agent'
-bug_project = 'ironic-python-agent'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/ironic-python-agent'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/test-requirements.txt b/test-requirements.txt
index c48ea5952..a9d9d7a15 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -12,6 +12,6 @@ bandit!=1.6.0,>=1.1.0,<2.0.0 # Apache-2.0
 
 # Doc requirements
 doc8>=0.6.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-openstackdocstheme>=1.20.0 # 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