From ce370bb2d66e8f0503cb234741ccf3dd71ff83c0 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 14:04:45 +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_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: I70aec0472ce090cb54855c58f20f4f02e20ae2c2 --- doc/source/conf.py | 7 ++++--- requirements.txt | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index fea695b..7023e03 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,8 +48,9 @@ except ImportError: # openstackdocstheme options html_theme = 'openstackdocs' -repository_name = 'openstack/vitrage-specs' -use_storyboard = True +openstackdocs_repo_name = 'openstack/vitrage-specs' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # The suffix of source filenames. source_suffix = '.rst' @@ -96,7 +97,7 @@ add_module_names = False 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 = ['vitrage-specs.'] diff --git a/requirements.txt b/requirements.txt index e134b2f..2403883 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,9 +3,9 @@ # process, which may cause wedges in the gate later. pbr!=2.1.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD graphviz>=0.4,!=0.5.0 # MIT License stestr>=2.0.0 testtools>=0.9.34 yasfb -openstackdocstheme>=1.28.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0