tox: add link checker environment, fix links (#1480)

1 files changed, 13 insertions, 0 deletions

diff --git a/tox.ini b/tox.ini
index a2df430c..9173db43 100644
--- a/tox.ini
+++ b/tox.ini
@@ -149,6 +149,19 @@ commands =
     {envpython} -m sphinx {posargs:-W doc/rtd doc/rtd_html}
     doc8 doc/rtd
 
+# linkcheck shows false positives and has noisy output.
+# Despite these limitations, it is better than a manual search of the docs.
+# suggested workflow is:
+#
+#     tox -e linkcheck | grep broken  # takes some time
+#
+# followed by manual verification of the links reported
+[testenv:linkcheck]
+deps =
+    -r{toxinidir}/doc-requirements.txt
+commands =
+    {envpython} -m sphinx {posargs:-b linkcheck doc/rtd doc/rtd_html}
+
 [testenv:tip-flake8]
 commands = {envpython} -m flake8 {posargs:cloudinit/ tests/ tools/ conftest.py setup.py}
 deps = flake8