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: I13e5de067ad381d058060bc5e297a0360804e119
This commit is contained in:
parent
925650079e
commit
e662da0d57
|
@ -1,2 +1,2 @@
|
||||||
sphinx>=2.0.0 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
openstackdocstheme>=2.0.0 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
|
|
|
@ -26,9 +26,10 @@ extensions = [
|
||||||
]
|
]
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/os-net-config'
|
openstackdocs_repo_name = 'openstack/os-net-config'
|
||||||
bug_project = 'os-net-config'
|
openstackdocs_auto_name = False
|
||||||
bug_tag = ''
|
openstackdocs_bug_project = 'os-net-config'
|
||||||
|
openstackdocs_bug_tag = ''
|
||||||
html_theme = 'openstackdocs'
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
|
@ -53,7 +54,7 @@ add_function_parentheses = True
|
||||||
add_module_names = True
|
add_module_names = True
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
|
|
@ -58,6 +58,12 @@ master_doc = 'index'
|
||||||
project = u'os-net-config Release Notes'
|
project = u'os-net-config Release Notes'
|
||||||
copyright = u'2018, OpenStackFoundation'
|
copyright = u'2018, OpenStackFoundation'
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
openstackdocs_repo_name = 'openstack/os-net-config'
|
||||||
|
openstackdocs_auto_name = False
|
||||||
|
openstackdocs_bug_project = 'os-net-config'
|
||||||
|
openstackdocs_bug_tag = ''
|
||||||
|
|
||||||
# Release notes are version independent
|
# Release notes are version independent
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = ''
|
release = ''
|
||||||
|
@ -94,7 +100,7 @@ exclude_patterns = []
|
||||||
# show_authors = False
|
# show_authors = False
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# 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.
|
# A list of ignored prefixes for module index sorting.
|
||||||
# modindex_common_prefix = []
|
# modindex_common_prefix = []
|
||||||
|
|
|
@ -9,4 +9,4 @@ python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||||
stestr>=2.0.0 # Apache-2.0
|
stestr>=2.0.0 # Apache-2.0
|
||||||
testscenarios>=0.4 # Apache-2.0/BSD
|
testscenarios>=0.4 # Apache-2.0/BSD
|
||||||
testtools>=1.4.0 # MIT
|
testtools>=1.4.0 # MIT
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
|
|
Loading…
Reference in New Issue