add doc link validation to release checklist and tox

This patch updates our doc 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
Boden R 6 years ago
parent 7b46312b92
commit fc6e9a71d8

@ -30,6 +30,11 @@ import logging
import os
import sys
import eventlet
# module ref generation can cause partial greening resulting in thread issues
# during the linkcheck builder, so initialize eventlet upfront
# NOTE(amotoki): In case of oslo_config.sphinxext is enabled,
# when resolving automodule neutron.tests.functional.db.test_migrations,
@ -271,3 +276,10 @@ config_generator_config_file = [
for conf in _config_generator_config_files
linkcheck_anchors_ignore = [
# skip gerrit anchors

@ -33,6 +33,8 @@ Prior to major release,
the context of the release planned;
#. check that release notes and sample configuration files render correctly,
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:

@ -125,6 +125,9 @@ commands = {posargs}
commands = sphinx-build -W -b html doc/source doc/build/html
commands = sphinx-build -W -b linkcheck doc/source doc/build/linkcheck
# E125 continuation line does not distinguish itself from next logical line
# E126 continuation line over-indented for hanging indent