From 3b650630dde9c9b2cd554d4cdd11c1e319191c33 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 20:56:49 +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. 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: I1ee2d1358312cf8a5edc228bbbf7d0703489c022 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 23fd8b4..fbe946e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ pbr>=2.0,!=2.1 -openstackdocstheme>=2.0 -sphinx>=2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD yasfb>=0.5.1 diff --git a/doc/source/conf.py b/doc/source/conf.py index 2d5fb92..c7db696 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,8 +23,9 @@ extensions = [ ] # openstackdocstheme settings -repository_name = 'openstack/constellations' -use_storyboard = True +openstackdocs_repo_name = 'openstack/constellations' +openstackdocs_use_storyboard = True +openstackdocs_auto_version = False version = '' release = '' @@ -57,7 +58,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output --------------------------------------------------