From b3e7c590f0df751c1b2a7ca4f04cbfaa543c0611 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 21 May 2020 09:41:50 +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.

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: I4ebb6e663471a7096bd9d0e1a90d8114d1875546
---
 api-ref/source/conf.py      |  7 +++----
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 10 +++++-----
 releasenotes/source/conf.py |  7 +++----
 4 files changed, 14 insertions(+), 16 deletions(-)

diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index 511405d58d..5f1657cb2b 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -64,9 +64,8 @@ master_doc = 'index'
 copyright = u'2010-present, OpenStack Foundation'
 
 # openstackdocstheme options
-repository_name = 'openstack/heat'
-bug_project = 'heat'
-bug_tag = 'api-ref'
+openstackdocs_repo_name = 'openstack/heat'
+openstackdocs_use_storyboard = True
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -95,7 +94,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 49b45a46a0..d47bc45af5 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,9 +2,9 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-openstackdocstheme>=1.20.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
-sphinx>=1.8.0,!=2.1.0 # BSD
-reno>=2.5.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+reno>=3.1.0 # Apache-2.0
 sphinxcontrib-apidoc>=0.2.0 # BSD
 sphinxcontrib-httpdomain>=1.3.0 # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 47192e14ed..eb772897a2 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -94,14 +94,14 @@ config_generator_config_file = '../../config-generator.conf'
 sample_config_basename = '_static/heat'
 
 # openstackdocstheme options
-repository_name = 'openstack/heat'
-bug_project = '989'
-bug_tag = 'docs'
+openstackdocs_repo_name = 'openstack/heat'
+openstackdocs_pdf_link = True
+openstackdocs_use_storyboard = True
 
 todo_include_todos = True
 
 # openstackdocstheme external link helper projects
-openstack_projects = [
+openstackdocs_projects = [
     'devstack',
     'diskimage-builder',
     'keystone',
@@ -158,7 +158,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 = ['heat.']
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 1ae00908af..b60748bb9e 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -43,9 +43,8 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/heat'
-bug_project = 'heat'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/heat'
+openstackdocs_use_storyboard = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -96,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 = []