From fce28c7042a91c1dfc9db234b37cb24715e96342 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 31 May 2020 19:39: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.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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: Ia6b784c59f8d511fecf5ea0bb6e603b8bce65422
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 16 ++++++----------
 lower-constraints.txt       |  5 -----
 releasenotes/source/conf.py | 14 +++++---------
 4 files changed, 14 insertions(+), 27 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 7ddda55..73ee25e 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
-sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 sphinxcontrib-httpdomain>=1.3.0 # BSD
 sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
-openstackdocstheme>=1.30.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
diff --git a/doc/source/conf.py b/doc/source/conf.py
index c1d4af0..dd01295 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -42,15 +42,6 @@ master_doc = 'index'
 project = u'Mistral Extra'
 copyright = u'2013, OpenStack Foundation'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.01'
-# The full version, including alpha/beta/rc tags.
-release = '0.01'
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -81,7 +72,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 = []
@@ -241,3 +232,8 @@ texinfo_documents = [
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+# -- Options for openstackdocstheme -------------------------------------------
+openstackdocs_repo_name = 'openstack/mistral-extra'
+openstackdocs_bug_project = 'mistral'
+openstackdocs_bug_tag = ''
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 8c3f2f8..2b9309b 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -7,15 +7,10 @@ hacking==1.1.0
 keystoneauth1===3.18.0
 mistral-lib==1.4.0
 mock==2.0.0
-openstackdocstheme==1.30.0
 oslo.log==3.36.0
 oslotest==3.2.0
 pbr==2.0.0
-reno==2.5.0
 requests-mock==1.2.0
-sphinx==1.8.0
-sphinxcontrib-httpdomain==1.3.0
-sphinxcontrib-pecanwsme==0.10.0
 stestr==2.0.0
 unittest2==1.1.0
 gnocchiclient==3.3.1
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index df7bc2c..8322900 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -92,7 +92,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 = []
@@ -141,11 +141,6 @@ html_theme = 'openstackdocs'
 # directly to the root of the documentation.
 # html_extra_path = []
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# Must set this variable to include year, month, day, hours, and minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True
@@ -271,6 +266,7 @@ texinfo_documents = [
 locale_dirs = ['locale/']
 
 # -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/mistral-extra'
-bug_project = 'mistral-extra'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/mistral-extra'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'mistral'
+openstackdocs_bug_tag = ''