From 4be7831173fd84637d67048a6ff6ab438deefd06 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 21:10:09 +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_version to not auto-version the documents. 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. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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: I33db298dd24f1e9795fb789f7c6964a97ba0651f --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 0d64c77..eccc937 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,2 @@ -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.20 # 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 7f5e071..1a46cf0 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,8 +27,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/reviewstats' -use_storyboard = True +openstackdocs_repo_name = 'openstack/reviewstats' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True html_theme = 'openstackdocs' # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -53,7 +54,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 --------------------------------------------------