From b32d0be3a06796e9e78858d9c89fb88ae1897d0f Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 24 May 2020 20:22:44 +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.

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: Ic5488acc81538c1dbde70fcc52d9175e3b98059a
---
 api-ref/source/conf.py      | 5 +++--
 doc/requirements.txt        | 4 ++--
 doc/source/conf.py          | 5 +++--
 releasenotes/source/conf.py | 5 +++--
 4 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index c909028..48972ed 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -39,9 +39,10 @@ html_theme = "openstackdocstheme"
 # html_theme_options = {}
 
 # openstackdocstheme settings
-repository_name = "openstack/adjutant"
+openstackdocs_repo_name = "openstack/adjutant"
+openstackdocs_auto_name = False
 html_theme = "openstackdocs"
-use_storyboard = True
+openstackdocs_use_storyboard = True
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
diff --git a/doc/requirements.txt b/doc/requirements.txt
index b55c8f8..ed88ba2 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
 os-api-ref>=1.6.1 # Apache-2.0
-openstackdocstheme>=2.0.0  # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
 sphinx>=2.0.0,!=2.1.0 # BSD
-reno>=2.11.3 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e300f00..cb49da6 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -36,9 +36,10 @@ extensions = ["openstackdocstheme"]
 templates_path = ["_templates"]
 
 # openstackdocstheme settings
-repository_name = "openstack/adjutant"
+openstackdocs_repo_name = "openstack/adjutant"
+openstackdocs_auto_name = False
 html_theme = "openstackdocs"
-use_storyboard = True
+openstackdocs_use_storyboard = True
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 911e2a7..c7b16d6 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -55,8 +55,9 @@ project = "Adjutant Release Notes"
 copyright = "2019, Adjutant Developers"
 
 # openstackdocstheme settings
-repository_name = "openstack/adjutant"
-use_storyboard = True
+openstackdocs_repo_name = "openstack/adjutant"
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
 
 # Release  notes are version independent