From c7b59254510c2ee9f2d169c8407c0c10f8b76d99 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Mon, 18 May 2020 22:53:05 +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.

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 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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Iafe611a36e17869bf17f5b2c016ef7c22fb36eb3
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 12 +++++-------
 releasenotes/source/conf.py | 13 +++++--------
 3 files changed, 13 insertions(+), 18 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 2bc4e850..2c08b50b 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,6 +2,6 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 # These are needed for docs generation
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
-openstackdocstheme>=1.18.1 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+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 4c282096..66bd075a 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -44,7 +44,6 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = 'python-tackerclient'
 copyright = 'OpenStack Contributors'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
@@ -55,7 +54,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 --------------------------------------------------
 
@@ -68,7 +67,6 @@ htmlhelp_basename = 'tackerclientdoc'
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 # -- Options for manual page output -------------------------------------------
 
@@ -79,10 +77,10 @@ man_pages = [
 
 # -- Options for openstackdocstheme -------------------------------------------
 
-repository_name = 'openstack/python-tackerclient'
-bug_project = 'python-tackerclient'
-bug_tag = 'doc'
+openstackdocs_repo_name = 'openstack/python-tackerclient'
+openstackdocs_bug_project = 'python-tackerclient'
+openstackdocs_bug_tag = 'doc'
 
 # -- Options for cliff.sphinxext plugin ---------------------------------------
 
-autoprogram_cliff_application = 'openstack'
\ No newline at end of file
+autoprogram_cliff_application = 'openstack'
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index fb806177..5ad659f2 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -90,7 +90,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 = []
@@ -131,10 +131,6 @@ html_theme = 'openstackdocs'
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# 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
@@ -259,6 +255,7 @@ texinfo_documents = [
 locale_dirs = ['locale/']
 
 # -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/python-tackerclient'
-bug_project = 'python-tackerclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-tackerclient'
+openstackdocs_bug_project = 'python-tackerclient'
+openstackdocs_bug_tag = ''
+openstackdocs_auto_name = False