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

Change-Id: Ifff5d0860f0c9e68a0187242335c5bf7c383a486
This commit is contained in:
Andreas Jaeger 2020-05-31 20:01:30 +02:00
parent 32ce7f05ad
commit 80c0851271
3 changed files with 12 additions and 10 deletions

View File

@ -1,5 +1,5 @@
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0

View File

@ -41,9 +41,10 @@ project = u'murano-tempest-plugin'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/murano-tempest-plugin'
bug_project = 'murano'
bug_tag = ''
openstackdocs_repo_name = 'openstack/murano-tempest-plugin'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'murano'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -53,7 +54,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 --------------------------------------------------

View File

@ -56,9 +56,10 @@ project = u'murano_tempest_tests Release Notes'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/murano-tempest-plugin'
bug_project = 'murano'
bug_tag = ''
openstackdocs_repo_name = 'openstack/murano-tempest-plugin'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'murano'
openstackdocs_bug_tag = ''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -100,7 +101,7 @@ exclude_patterns = []
# 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 = []