From 0f957ca9c6e3c21ef17d6ba95e03228fb5cf27ed Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 20:29:30 +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: I7a7bf796d3f25e4dd3d1709850729d29497d355e --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 5 ++++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index b2f4df795..db0dbb9c8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-blockdiag>=1.1.0 -openstackdocstheme>=1.31.2 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 10d3526c3..69e7292af 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -39,6 +39,9 @@ master_doc = 'index' project = u'openstack-helm-infra' copyright = u'2016, OpenStack Foundation' +openstackdocs_repo_name = 'openstack/openstack-helm-infra' +openstackdocs_use_storyboard = True + # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -51,7 +54,7 @@ add_module_names = True show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for