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: I9843c6b66d4411857cb19c5d176d39b200423257
This commit is contained in:
Andreas Jaeger 2020-05-31 17:54:17 +02:00
parent de4e2ef95b
commit 84b9989a79
2 changed files with 8 additions and 15 deletions

View File

@ -29,14 +29,11 @@ extensions = [
'sphinxcontrib.seqdiag',
'sphinxcontrib.nwdiag',
'openstackdocstheme',
# TODO(tbarron): re-enable yasfb after
# https://github.com/sphinxcontrib/yasfb/commit/62d18c66835320af4a71fb088cb502041478fb16
# is released; it currently breaks with python 3.5
# 'yasfb',
'yasfb',
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/manila-specs'
feed_base_url = 'https://specs.openstack.org/openstack/manila-specs'
feed_author = 'OpenStack Manila Team'
exclude_patterns = [
@ -65,7 +62,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 --------------------------------------------------
@ -78,10 +75,6 @@ html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@ -95,6 +88,6 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}
repository_name = 'openstack/manila-specs'
bug_project = 'manila'
bug_tag = ''
openstackdocs_repo_name = 'openstack/manila-specs'
openstackdocs_bug_project = 'manila'
openstackdocs_bug_tag = ''

View File

@ -3,9 +3,9 @@ pbr>=2.0.0
actdiag
blockdiag
nwdiag
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
seqdiag
sphinx>=1.5.1,!=1.6.1 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-actdiag
sphinxcontrib-blockdiag # BSD
sphinxcontrib-nwdiag