From 0317054c51dbbaef73cceb491d2e575b91c24ce7 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 19:30:50 +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. 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: I4ae8e3811b184219c1715af0629f668b393ad3c2 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 8 +++++++- releasenotes/source/conf.py | 8 +++++++- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index a3af000..26cc079 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinx>=2.0.0,!=2.1.0 # BSD oslosphinx>=4.7.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain diff --git a/doc/source/conf.py b/doc/source/conf.py index 5e35d8b..facf9cd 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -39,6 +39,12 @@ master_doc = 'index' project = u'mistral-dashboard' copyright = u'2014, OpenStack Foundation' +# -- Options for openstackdocstheme ------------------------------------------- + +openstackdocs_repo_name = 'openstack/mistral-dashboard' +openstackdocs_bug_project = 'mistral' +openstackdocs_bug_tag = 'doc' + # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -47,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/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3cc09c3..8965baa 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,6 +38,12 @@ master_doc = 'index' project = u'Mistral Dashboard Release Notes' copyright = u'2016, Mistral developers' +# -- Options for openstackdocstheme ------------------------------------------- + +openstackdocs_repo_name = 'openstack/mistral-dashboard' +openstackdocs_bug_project = 'mistral' +openstackdocs_bug_tag = 'doc' + # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -46,7 +52,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 --------------------------------------------------