From 1bdabe90666972b4349662d535b11fb0046e57ee Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 14:24:33 +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: I4f371ec10b03aeff2ee0af7dab60403359cf69b0 --- 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 c705b30..e7219e8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ # 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. -openstackdocstheme>=1.18.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 1fdadd6..c71f941 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,9 +27,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/devstack-plugin-nfs' -bug_project = 'devstack-plugin-nfs' -bug_tag = '' +openstackdocs_repo_name = 'openstack/devstack-plugin-nfs' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'devstack-plugin-nfs' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -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 --------------------------------------------------