From 3309e689e258ee06d12c1c3772c7cece13dd76fe Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 31 May 2020 19:59:42 +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: I7f8c249b574213a9189e13f679179bbaaa382e28
---
 doc/requirements.txt        | 6 +++---
 doc/source/conf.py          | 7 ++++++-
 releasenotes/source/conf.py | 8 +++++++-
 3 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 3a5b7ae..ec81ae0 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
 # doc build requirements
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 sphinxcontrib-httpdomain>=1.3.0 # BSD
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.20.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0ccbce2..79b8242 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -45,7 +45,12 @@ add_function_parentheses = True
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
+
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/yaql'
+openstackdocs_bug_project = 'yaql'
+openstackdocs_bug_tag = ''
 
 # -- Options for HTML output --------------------------------------------------
 
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 04870fe..5afd95f 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -95,7 +95,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 = []
@@ -103,6 +103,12 @@ pygments_style = 'sphinx'
 # If true, keep warnings as "system message" paragraphs in the built documents.
 # keep_warnings = False
 
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/yaql'
+openstackdocs_bug_project = 'yaql'
+openstackdocs_auto_name = False
+openstackdocs_bug_tag = ''
+
 
 # -- Options for HTML output ----------------------------------------------