From a2c25d956cf0620c1f0d1e73f1820f59072b49bb Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Jun 2020 14:22:19 +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: I3613f3b9e1f12fd7735f1dba6918a68784d9c259 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 9 +++++---- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 0e74ac4..0673b3d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # 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 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 3be5f6c..e22265a 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,9 +27,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/stackviz' -bug_project = 'stackviz' -bug_tag = '' +openstackdocs_repo_name = 'openstack/stackviz' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'stackviz' +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 --------------------------------------------------