From c7994d482a210a5e6862da4ab336102ebc82ba72 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 16:09:35 +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: I5d028974e3feed93ee5883bb3d12f254dbd8099d --- 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 c2d52ba6..62dff0de 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,8 +1,8 @@ # 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. -sphinx>=2.0.0 # BSD -openstackdocstheme>=1.32.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 sphinxcontrib-actdiag # BSD sphinxcontrib-blockdiag # BSD sphinxcontrib-nwdiag # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 749ee282..145656f7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -89,7 +89,7 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['tacker-specs.'] @@ -229,6 +229,7 @@ texinfo_documents = [ #texinfo_show_urls = 'footnote' # openstackdocstheme options -repository_name = 'openstack/tacker-specs' -bug_project = 'tacker' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/tacker-specs' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'tacker' +openstackdocs_bug_tag = 'doc'