From a034ce54c26a85bad99db5480ca5180a16eec2f5 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 19 May 2020 08:03:46 +0200
Subject: [PATCH] Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.0 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.

Set openstackdocs_auto_name to use 'project' 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.

Change-Id: I8de23470cda92374f7b6df89548bbbe23570805f
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          |  5 ++---
 releasenotes/source/conf.py | 10 ++++------
 3 files changed, 9 insertions(+), 12 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 4fb957a..76d5308 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,6 @@
 # The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2  # BSD
-openstackdocstheme>=1.24.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e6b5ff7..90679f2 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -26,8 +26,8 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/python-vitrageclient'
-use_storyboard = True
+openstackdocs_repo_name = 'openstack/python-vitrageclient'
+openstackdocs_use_storyboard = True
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -63,7 +63,6 @@ html_theme = 'openstackdocs'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 9d78404..6cd3712 100755
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -20,16 +20,15 @@ sys.path.insert(0, os.path.abspath('../..'))
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
     'reno.sphinxext',
     'openstackdocstheme'
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/python-vitrageclient'
-bug_project = 'python-vitrageclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-vitrageclient'
+openstackdocs_bug_project = 'python-vitrageclient'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -62,7 +61,6 @@ pygments_style = 'sphinx'
 # html_theme_path = ["."]
 html_theme = 'openstackdocs'
 # html_static_path = ['static']
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project