From befadaa1b0e3a80873281c14f5f31fd9091bf767 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 21:00:10 +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: I30bdb1bf76a12e9562ab461b2701a36f34e770fe --- doc/source/conf.py | 6 +++++- requirements.txt | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 67156ce..a9a364f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -54,6 +54,10 @@ master_doc = 'index' project = u'API Special Interest Group' copyright = u'%s, OpenStack API Special Interest Group Team' % datetime.date.today().year +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/api-sig' +openstackdocs_auto_name = False + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -85,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 = [] diff --git a/requirements.txt b/requirements.txt index 00356bb..cea5693 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,8 +3,8 @@ # process, which may cause wedges in the gate later. pbr>=2.0 doc8>=0.6.0 # Apache-2.0 -openstackdocstheme>=1.31.2 # 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 stestr>=2.0.0 # Apache-2.0 testtools>=0.9.36,!=1.2.0 yasfb>=0.8.0