From cb738addb5d9bce7b744b56e5eb6109694174dab Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 21:07:37 +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: I51704af235e07625812e3b035e72b0408fad793c --- doc/source/conf.py | 10 +++++----- requirements.txt | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 11ca17d..492f0c0 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,12 +31,12 @@ extensions = [ html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/self-healing-sig' -bug_project = '917' -bug_tag = '' +openstackdocs_repo_name = 'openstack/self-healing-sig' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/self-healing-sig' +feed_base_url = 'https://specs.openstack.org/openstack/self-healing-sig' feed_author = 'OpenStack Self-healing SIG' exclude_patterns = [ @@ -74,7 +74,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 -------------------------------------------------- diff --git a/requirements.txt b/requirements.txt index 3d69233..d6b00f1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ pbr>=2.0.0 -openstackdocstheme +openstackdocstheme>=2.2.1 # Apache-2.0 yasfb>=0.5.1