From f0c5a38fcb1eccb26f692479069baa431b81b077 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 26 May 2020 08:12:30 +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.

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: I3984c5b0a99f5dd1224ebd29b16ebbef14225f49
---
 {{cookiecutter.repo_name}}/doc/requirements.txt    |  6 +++---
 {{cookiecutter.repo_name}}/doc/source/conf.py      |  9 ++++-----
 .../releasenotes/source/conf.py                    | 14 +++++---------
 3 files changed, 12 insertions(+), 17 deletions(-)

diff --git a/{{cookiecutter.repo_name}}/doc/requirements.txt b/{{cookiecutter.repo_name}}/doc/requirements.txt
index afd3597..60ba470 100644
--- a/{{cookiecutter.repo_name}}/doc/requirements.txt
+++ b/{{cookiecutter.repo_name}}/doc/requirements.txt
@@ -1,4 +1,4 @@
-sphinx!=1.6.6,!=1.6.7,>=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
 # releasenotes
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/{{cookiecutter.repo_name}}/doc/source/conf.py b/{{cookiecutter.repo_name}}/doc/source/conf.py
index 297ed23..73b1204 100755
--- a/{{cookiecutter.repo_name}}/doc/source/conf.py
+++ b/{{cookiecutter.repo_name}}/doc/source/conf.py
@@ -41,10 +41,9 @@ project = u'{{cookiecutter.repo_name}}'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
-bug_project = '{{cookiecutter.bug_project}}'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
+openstackdocs_bug_project = '{{cookiecutter.bug_project}}'
+openstackdocs_bug_tag = ''
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -54,7 +53,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/{{cookiecutter.repo_name}}/releasenotes/source/conf.py b/{{cookiecutter.repo_name}}/releasenotes/source/conf.py
index 6b96ee2..4201b70 100644
--- a/{{cookiecutter.repo_name}}/releasenotes/source/conf.py
+++ b/{{cookiecutter.repo_name}}/releasenotes/source/conf.py
@@ -56,10 +56,10 @@ project = u'{{cookiecutter.module_name}} Release Notes'
 copyright = u'2017, OpenStack Developers'
 
 # openstackdocstheme options
-repository_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
-bug_project = '{{cookiecutter.bug_project}}'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
+openstackdocs_bug_project = '{{cookiecutter.bug_project}}'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = 'False'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -101,7 +101,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 = []
@@ -150,10 +150,6 @@ html_static_path = ['_static']
 # 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.
-# html_last_updated_fmt = '%b %d, %Y'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True