From d2be2c597400549797197e822198cb6f7e6a941b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 16:28:22 +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: I77e62e13b1e08556bd47941613fa8be338eb8d9e --- doc/source/conf.py | 11 ++++++----- requirements.txt | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 366b611..8a64204 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,12 +31,13 @@ extensions = [ html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/multi-arch-sig' -bug_project = '917' -bug_tag = '' +openstackdocs_repo_name = 'openstack/multi-arch-sig' +openstackdocs_auto_name = False +openstackdocs_auto_version = False +openstackdocs_use_storyboard = True # Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/multi-arch-sig' +feed_base_url = 'https://specs.openstack.org/openstack/multi-arch-sig' feed_author = 'OpenStack Multi-Arch SIG' exclude_patterns = [ @@ -74,7 +75,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 f3a49e4..d6b00f1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ pbr>=2.0.0 -openstackdocstheme>=1.31.2 +openstackdocstheme>=2.2.1 # Apache-2.0 yasfb>=0.5.1