add doc link validation to release checklist and tox
This patch updates our doc conf.py to support the linkcheck builder in addition to adding a new 'linkcheck' target in tox to run the builder. Also the release checklist is updated suggesting the linkcheck tox target be run prior to a release. Change-Id: Ia7c282b7331f0b624bb3324f27dfec223cf414f7 Closes-Bug: #1716005
This commit is contained in:
parent
7b46312b92
commit
fc6e9a71d8
|
@ -30,6 +30,11 @@ import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
import eventlet
|
||||||
|
|
||||||
|
# module ref generation can cause partial greening resulting in thread issues
|
||||||
|
# during the linkcheck builder, so initialize eventlet upfront
|
||||||
|
eventlet.monkey_patch()
|
||||||
|
|
||||||
# NOTE(amotoki): In case of oslo_config.sphinxext is enabled,
|
# NOTE(amotoki): In case of oslo_config.sphinxext is enabled,
|
||||||
# when resolving automodule neutron.tests.functional.db.test_migrations,
|
# when resolving automodule neutron.tests.functional.db.test_migrations,
|
||||||
|
@ -271,3 +276,10 @@ config_generator_config_file = [
|
||||||
_get_config_generator_config_definition(conf)
|
_get_config_generator_config_definition(conf)
|
||||||
for conf in _config_generator_config_files
|
for conf in _config_generator_config_files
|
||||||
]
|
]
|
||||||
|
|
||||||
|
linkcheck_anchors_ignore = [
|
||||||
|
# skip gerrit anchors
|
||||||
|
'\/q\/.*',
|
||||||
|
'q\,.*',
|
||||||
|
'\/c\/.*'
|
||||||
|
]
|
||||||
|
|
|
@ -33,6 +33,8 @@ Prior to major release,
|
||||||
the context of the release planned;
|
the context of the release planned;
|
||||||
#. check that release notes and sample configuration files render correctly,
|
#. check that release notes and sample configuration files render correctly,
|
||||||
arrange clean-up if needed.
|
arrange clean-up if needed.
|
||||||
|
#. ensure all doc links are valid by running ``tox -e linkcheck`` and
|
||||||
|
addressing any broken links.
|
||||||
|
|
||||||
New major release process contains several phases:
|
New major release process contains several phases:
|
||||||
|
|
||||||
|
|
3
tox.ini
3
tox.ini
|
@ -125,6 +125,9 @@ commands = {posargs}
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
||||||
|
[testenv:linkcheck]
|
||||||
|
commands = sphinx-build -W -b linkcheck doc/source doc/build/linkcheck
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
# E125 continuation line does not distinguish itself from next logical line
|
# E125 continuation line does not distinguish itself from next logical line
|
||||||
# E126 continuation line over-indented for hanging indent
|
# E126 continuation line over-indented for hanging indent
|
||||||
|
|
Loading…
Reference in New Issue