From 6d317a4e68342e96729a4bf6623ec1cd4d7d384a Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 4 Jun 2020 14:41:16 +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: I4a29839379aaf82893f3f34af17f6134091e7064
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 14 +++++---------
 releasenotes/source/conf.py | 12 +++++-------
 3 files changed, 13 insertions(+), 19 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 3a7529d3..f9f7a73d 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
-sphinx>=1.6.2
-openstackdocstheme>=1.26.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 
 # Release Notes documentation
-reno>=0.1.1 # Apache2
+reno>=3.1.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a4782d84..03cc115b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -27,12 +27,6 @@ project = u'StarlingX Upstream'
 copyright = u'2018, StarlingX'
 author = u'StarlingX'
 
-# The short X.Y version
-version = u''
-# The full version, including alpha/beta/rc tags
-release = u'0.1'
-
-
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -58,8 +52,10 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
-bug_project = '1027'
-bug_tag = 'stx.bug'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/upstream'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -74,7 +70,7 @@ language = None
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 
 # -- Options for HTML output -------------------------------------------------
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 7494090a..1f22c63f 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -31,8 +31,10 @@ extensions = [
     'reno.sphinxext',
 ]
 
-bug_project = '1027'
-bug_tag = 'stx.bug'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/upstream'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
@@ -82,7 +84,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 +133,6 @@ html_theme = 'starlingxdocs'
 # 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 = '%Y-%m-%d %H:%M'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True