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: I1d291a4755a86ef2564a675eaa25b6d98585b610
This commit is contained in:
Andreas Jaeger 2020-06-02 14:04:01 +02:00
parent c7f009d64c
commit 9a1193ba18
5 changed files with 13 additions and 11 deletions

View File

@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
oslo.config>=5.2.0 # Apache-2.0 oslo.config>=5.2.0 # Apache-2.0
openstackdocstheme>=1.31.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.7.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain docutils>=0.11 # OSI-Approved Open Source, Public Domain

View File

@ -57,7 +57,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 --------------------------------------------------
@ -69,8 +69,9 @@ html_static_path = ['_static']
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/vitrage' openstackdocs_repo_name = 'openstack/vitrage'
use_storyboard = True openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

View File

@ -104,7 +104,7 @@ python-troveclient==2.2.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
pyzabbix==0.7.4 pyzabbix==0.7.4
reno==2.7.0 reno==3.1.0
repoze.lru==0.7 repoze.lru==0.7
requests==2.18.4 requests==2.18.4
requests-mock==1.4.0 requests-mock==1.4.0

View File

@ -38,8 +38,9 @@ project = u'vitrage releasenotes'
copyright = u'2016, Vitrage developers' copyright = u'2016, Vitrage developers'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/vitrage' openstackdocs_repo_name = 'openstack/vitrage'
use_storyboard = True openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@ -49,7 +50,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 --------------------------------------------------

View File

@ -10,5 +10,5 @@ requests-mock>=1.4.0 # Apache-2.0
testscenarios>=0.5.0 # Apache-2.0/BSD testscenarios>=0.5.0 # Apache-2.0/BSD
testtools>=2.3.0 # MIT testtools>=2.3.0 # MIT
stestr>=2.0.0 # Apache-2.0 stestr>=2.0.0 # Apache-2.0
reno>=2.7.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
zake>=0.1.6 # Apache-2.0 zake>=0.1.6 # Apache-2.0