From 546b9c3856527e516bfb60863e941dfa48c1fada Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 16:36:48 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. 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. 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 The repo is setup in project-config to use storyboard, so update the config. Change-Id: I1ba7f47312fea8de36c4c0c0ca6bf9c2220cbf42 --- doc/source/conf.py | 8 ++++---- test-requirements.txt | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 20009a5..2bb0a2d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,9 +41,9 @@ project = u'cyborg-specs' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/cyborg-specs' -bug_project = 'cyborg' -bug_tag = '' +openstackdocs_repo_name = 'openstack/cyborg-specs' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -53,7 +53,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/test-requirements.txt b/test-requirements.txt index dcee184..59492f3 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,6 +5,6 @@ hacking>=3.0,<3.1 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2' # BSD +sphinx>=2.0.0,!=2.1.0 # BSD stestr>=1.0.0 # Apache-2.0 -openstackdocstheme>=1.32.1 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0