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: I45295290471a5d8d32fb11ddbb64a8accdb7710a
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 3d9b56e..fe1b603 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -41,9 +41,9 @@
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
-repository_name = 'openstack/openstack'
-bug_project = 'telemetry_tempest_plugin'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/openstack'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@@ -53,7 +53,7 @@
add_module_names = True
# 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 24e5e0e..83b2967 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -56,9 +56,9 @@
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
-repository_name = 'openstack/openstack'
-bug_project = 'telemetry_tempest_plugin'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/telemetry-tempest-plugin'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -100,7 +100,7 @@
# 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 = []
@@ -149,10 +149,6 @@
# 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 = '%b %d, %Y'
-
# 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 d29869c..f8e7e3a 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,6 +5,6 @@
hacking>=3.0.1,<3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
-openstackdocstheme>=2.0.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
-reno>=2.5.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0