From 09b0eaace50c5307bf0a95a249e7515d1ba86ef5 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 16:12:32 +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: Ibc047f8a603fd81b32e3e4dd29a9eab283cc1048 --- doc/source/conf.py | 9 +++++---- requirements.txt | 4 ++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a5ac75d..e754a8e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,9 +29,10 @@ extensions = [ # openstackdocstheme options -repository_name = 'openstack/trove-specs' -bug_project = 'trove-specs' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/trove-specs' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'trove-specs' +openstackdocs_bug_tag = 'doc' # Optionally allow the use of sphinxcontrib.spelling to verify the # spelling of the documents. @@ -67,7 +68,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 21d9830..1c1c7eb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ -openstackdocstheme>=2.0.0 -sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD testrepository>=0.0.18 testtools>=0.9.34 yasfb>=0.5.1