From 3c2f6f71e97e37ea9b92507fb37bc93450ce1477 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 19:44:54 +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. 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: I84774e86b7b834af52ace910cb1924f883e41cb9 --- doc/source/conf.py | 9 +++++---- requirements.txt | 4 ++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2b00f08..a25417d 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,7 +34,7 @@ extensions = ['redirect', ] # Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/monasca-specs' +feed_base_url = 'https://specs.openstack.org/openstack/monasca-specs' feed_author = 'Monasca Team' todo_include_todos = True @@ -70,7 +70,7 @@ copyright = u'%s, Monasca Team' % datetime.date.today().year #add_function_parentheses = True # 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 = ['monasca-specs.'] @@ -150,5 +150,6 @@ html_use_index = False # -- openstackdocstheme configuration ----------------------------------------- -repository_name = 'openstack/monasca-specs' -use_storyboard = True +openstackdocs_repo_name = 'openstack/monasca-specs' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True diff --git a/requirements.txt b/requirements.txt index c67eaf9..00cbc28 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,8 +2,8 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. pbr!=2.1.0,>=2.0.0 # Apache-2.0 -openstackdocstheme>=1.32.1 # Apache-2.0 -sphinx>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT yasfb>=0.8.0 # BSD