From 29bf1e1465878b7f666ae65ae9ddec3d161030f0 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Wed, 3 Jun 2020 18:18:59 +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.

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: I125fc53d6f30fa72e6814526080b79264eb6bf55
---
 doc/requirements.txt        | 6 +++---
 doc/source/conf.py          | 7 ++++---
 releasenotes/source/conf.py | 6 +++---
 3 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 52fe55a..07801f8 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -9,8 +9,8 @@
 # openstack-ansible-tests repository. Once it merges there, the changes will
 # automatically be proposed to all the repositories which use it.
 
-sphinx>=2.0.0,!=2.1.0  # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
-openstackdocstheme>=2.0.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 doc8>=0.6.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e30703c..4e05a44 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -66,9 +66,10 @@ target_name = 'ansible-role-' + role_name
 title = 'OpenStack-Ansible Documentation: ' + role_name + ' role'
 
 # openstackdocstheme options
-repository_name = 'openstack/' + target_name
-bug_project = project.lower()
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/' + target_name
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = project.lower()
+openstackdocs_bug_tag = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 2a7edf3..3f8c787 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -70,9 +70,9 @@ release = ''
 version = ''
 
 # openstackdocstheme options
-repository_name = 'openstack/' + target_name
-bug_project = project.lower()
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/' + target_name
+openstackdocs_bug_project = project.lower()
+openstackdocs_bug_tag = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.