From b4f16ab7e86a8cf9a75cd48a6a4cdb949835e065 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 4 Jun 2020 14:20:59 +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 test-requirements.txt, 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: Id86f483b405c8fbc74b89ac085076b55e461d417
---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 15 ++++++---------
 releasenotes/source/conf.py | 12 +++++-------
 test-requirements.txt       |  2 --
 4 files changed, 14 insertions(+), 21 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 ded6c00b..003409fc 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -27,12 +27,6 @@ project = u'StarlingX GUI'
 copyright = '2018, StarlingX'
 author = 'StarlingX'
 
-# The short X.Y version
-version = ''
-# The full version, including alpha/beta/rc tags
-release = '0.1'
-
-
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -58,8 +52,11 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
-bug_project = '1027'
-bug_tag = 'stx.bug'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/gui'
+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 +71,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 b24d13a2..176e4112 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/gui'
+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
diff --git a/test-requirements.txt b/test-requirements.txt
index 2f486674..ebf4b5bd 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -18,10 +18,8 @@ nose-exclude # LGPL
 nosehtmloutput>=0.0.3 # Apache-2.0
 nosexcover # BSD
 openstack.nose-plugin>=0.7 # Apache-2.0
-oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
 requests>=2.10.0 # Apache-2.0
 selenium>=2.50.1 # Apache-2.0
-sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
 testtools>=1.4.0 # MIT
 # This also needs xvfb library installed on your OS
 xvfbwrapper>=0.1.3 #license: MIT