From 9704c344c1169206904c29b215bc8fa4995f269e Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 17:08:00 +0200 Subject: [PATCH] Switch to newer openstackdocstheme version Switch to openstackdocstheme 2.2.1 version. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. 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: I853c21c0789296164632c47a0b3534321cec01ee --- doc/source/conf.py | 8 ++++++-- requirements.txt | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e3e176fa..72e151e2 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,7 +29,7 @@ extensions = [ ] # Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/heat-specs' +feed_base_url = 'https://specs.openstack.org/openstack/heat-specs' feed_author = 'OpenStack Heat Team' exclude_patterns = [ @@ -58,6 +58,10 @@ master_doc = 'index' project = u'heat-specs' copyright = u'%s, OpenStack Foundation' % datetime.date.today().year +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/heat-specs' +openstackdocs_use_storyboard = True + # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -66,7 +70,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 -------------------------------------------------- diff --git a/requirements.txt b/requirements.txt index ca0f7d1f..f5d9380f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ pbr>=0.6,<1.0 -openstackdocstheme -sphinx>=2.0.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD yasfb>=0.8.0