From 78ae004de11d71d746bdc208a1bc461f91a91f4d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 15:49:24 +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: Iecd379c54ddbd4aedb45803897f33f31203b8048 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 29695ca4a1..9580f87895 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,3 @@ # this is required for the docs build jobs -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD -openstackdocstheme>=1.31.2 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 16ec627208..1aa7b2fc86 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -69,15 +69,16 @@ 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 = ['requirements-doc.'] # openstackdocstheme options -repository_name = 'openstack/requirements' -bug_project = 'openstack-requirements' -bug_tag = '' +openstackdocs_repo_name = 'openstack/requirements' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'openstack-requirements' +openstackdocs_bug_tag = '' # -- Options for man page output ---------------------------------------------- man_pages = []