From 82f7e4a1ff953ebfebca9536d543d3c1344d941b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 14:23:23 +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: I04809a3cbfaaea711509f4a16548e4813780ddfc --- doc/source/conf.py | 9 +++++---- test-requirements.txt | 4 ++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 5d111af..1465cd4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,12 +48,13 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # openstackdocstheme options -repository_name = 'openstack/tempest-stress' -bug_project = 'tempest' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/tempest-stress' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'tempest' +openstackdocs_bug_tag = 'doc' # -- Options for HTML output -------------------------------------------------- diff --git a/test-requirements.txt b/test-requirements.txt index fe2c1d1..2ceba7c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,8 +7,8 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0 coverage>=3.6 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx>=2.0.0 # BSD -openstackdocstheme>=2.0.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT