From 6c963e7712e57a1aabb1c4c816b01c59625bdccd Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 14 May 2020 21:32:12 +0200
Subject: [PATCH] Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.1.2 and reno 3.1.0 versions. Using
these versions will allow parallelizing building of documents.

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_version to not version the documents.
Set openstackdocs_auto_name to use project as name.

Depends-On: https://review.opendev.org/728432
Change-Id: I4e3ae3ceabe125ea459ed4baabf2e98686268e50
---
 api-guide/source/conf.py    | 18 +++++++-----------
 api-ref/source/conf.py      |  6 +++---
 doc/requirements.txt        |  6 +++---
 doc/source/conf.py          | 11 ++++++-----
 releasenotes/source/conf.py |  6 +++---
 5 files changed, 22 insertions(+), 25 deletions(-)

diff --git a/api-guide/source/conf.py b/api-guide/source/conf.py
index af340a3552a3..fafb397e197d 100644
--- a/api-guide/source/conf.py
+++ b/api-guide/source/conf.py
@@ -50,12 +50,6 @@ todo_include_todos = True
 master_doc = 'index'
 # General information about the project.
 project = u'Compute API Guide'
-bug_tag = u'api-guide'
-repository_name = 'openstack/nova'
-bug_project = 'nova'
-
-# Must set this variable to include year, month, day, hours, and minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 copyright = u'2015, OpenStack contributors'
 
@@ -147,10 +141,6 @@ html_static_path = []
 # 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
@@ -284,9 +274,15 @@ pdf_documents = [
 
 # -- Options for openstackdocstheme -------------------------------------------
 
-openstack_projects = [
+openstackdocs_projects = [
     'glance',
     'nova',
     'neutron',
     'placement',
 ]
+
+openstackdocs_bug_tag = u'api-guide'
+openstackdocs_repo_name = 'openstack/nova'
+openstackdocs_bug_project = 'nova'
+openstackdocs_auto_version = False
+openstackdocs_auto_name = False
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index 23fd173a8128..e17a59eb75a3 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -43,9 +43,9 @@ master_doc = 'index'
 copyright = u'2010-present, OpenStack Foundation'
 
 # openstackdocstheme options
-repository_name = 'openstack/nova'
-bug_project = 'nova'
-bug_tag = 'api-ref'
+openstackdocs_repo_name = 'openstack/nova'
+openstackdocs_bug_project = 'nova'
+openstackdocs_bug_tag = 'api-ref'
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 48352ebc2a20..ec4298aec9f1 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,16 +1,16 @@
 # The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
-sphinx>=1.8.0,!=2.1.0 # BSD
+sphinx>=2.0.0,!=2.1.0 # BSD
 sphinxcontrib-actdiag>=0.8.5 # BSD
 sphinxcontrib-seqdiag>=0.8.4 # BSD
 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
 sphinx-feature-classification>=0.2.0 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
-openstackdocstheme>=1.30.0 # Apache-2.0
+openstackdocstheme>=2.1.2 # Apache-2.0
 
 # releasenotes
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 
 # redirect tests in docs
 whereto>=0.3.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4998c4cd27a8..29c6c03f165e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -47,10 +47,6 @@ extensions = [
     'sphinxcontrib.rsvgconverter',
 ]
 
-# openstackdocstheme options
-repository_name = 'openstack/nova'
-bug_project = 'nova'
-bug_tag = 'doc'
 
 config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
 sample_config_basename = '_static/nova'
@@ -142,11 +138,16 @@ latex_use_xindy = False
 
 # -- Options for openstackdocstheme -------------------------------------------
 
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/nova'
+openstackdocs_bug_project = 'nova'
+openstackdocs_bug_tag = 'doc'
+
 # keep this ordered to keep mriedem happy
 #
 # NOTE(stephenfin): Projects that don't have a release branch, like TripleO and
 # reno, should not be included here
-openstack_projects = [
+openstackdocs_projects = [
     'ceilometer',
     'cinder',
     'cyborg',
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 55d43481882d..42941e71a0c0 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -43,9 +43,9 @@ master_doc = 'index'
 # General information about the project.
 copyright = u'2015, Nova developers'
 # openstackdocstheme options
-repository_name = 'openstack/nova'
-bug_project = 'nova'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/nova'
+openstackdocs_bug_project = 'nova'
+openstackdocs_bug_tag = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.