From 5ad6748225b0b303b52ed72bdc4db9218f16f169 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 26 May 2020 08:06:42 +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: I3adc259f89f9093fbe9cce1353f5d6f0828271b9
---
 doc/requirements.txt        |  4 ++--
 doc/source/conf.py          | 10 +++++-----
 lower-constraints.txt       |  5 +----
 releasenotes/source/conf.py |  8 +++++++-
 test-requirements.txt       |  2 +-
 5 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 5ce890b..645c84b 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -4,5 +4,5 @@
 
 # For generating sphinx documentation
 doc8>=0.6.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
-openstackdocstheme>=1.18.1 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index c6ff40f..6ffb299 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -29,10 +29,10 @@ extensions = [
 ]
 
 # openstackdocstheme options
-repository_name = 'openstack/automaton'
-bug_project = 'automaton'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = 'openstack/automaton'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'automaton'
+openstackdocs_bug_tag = ''
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
@@ -56,7 +56,7 @@ add_function_parentheses = True
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # -- Options for HTML output --------------------------------------------------
 
diff --git a/lower-constraints.txt b/lower-constraints.txt
index c49b450..0209816 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -19,7 +19,6 @@ MarkupSafe==1.0
 mccabe==0.2.1
 mock==2.0.0
 mox3==0.20.0
-openstackdocstheme==1.18.1
 os-client-config==1.28.0
 oslotest==3.2.0
 pbr==2.0.0
@@ -31,14 +30,12 @@ python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
+reno==3.1.0
 requests==2.14.2
 requestsexceptions==1.2.0
 restructuredtext-lint==1.1.1
 six==1.10.0
 snowballstemmer==1.2.1
-Sphinx==1.6.2
-sphinxcontrib-websupport==1.0.1
 stevedore==1.20.0
 stestr==2.0.0
 testtools==2.2.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 47be52e..84e299e 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -95,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 = []
@@ -274,3 +274,9 @@ texinfo_documents = [
 
 # -- Options for Internationalization output ------------------------------
 locale_dirs = ['locale/']
+
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/automaton'
+openstackdocs_auto_name = False
+openstackdocs_bug_project = 'automaton'
+openstackdocs_bug_tag = ''
diff --git a/test-requirements.txt b/test-requirements.txt
index 2490c01..08ec37c 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8,4 +8,4 @@ coverage!=4.4,>=4.0 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
 testtools>=2.2.0 # MIT
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0