From 50e628a7f9d0cb6a6463749b8aaaee2128e0309d Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 4 Jun 2020 14:35:00 +0200
Subject: [PATCH] Switch to newer openstackdocstheme version

Switch to openstackdocstheme 2.2.1 version. Using
this version 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_version to not auto-version the documents.

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: I45a4543ee3726071eb36b8addc7a0662070923ec
---
 doc/requirements.txt |  6 +++---
 doc/source/conf.py   | 17 +++++++----------
 2 files changed, 10 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 16b52e4..74bd62f 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
-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 9fe3759..7459ddb 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -21,16 +21,10 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u'stx-specs'
+project = u'StarlingX Specs'
 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.
@@ -56,8 +50,11 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
-bug_project = '1027'
-bug_tag = 'stx.bug'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/specs'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
+openstackdocs_auto_version = False
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -72,7 +69,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 -------------------------------------------------