d2a9a6380a
Enable the built-in Sphinx 'linkcheck' builder and fix initial findings. Add this as an opportunistic build target only. The process is long, and false positives are common (mostly anchor-related for some reason). There is also already a third-party company-wide service in place. This builder however will lead to better link hygiene as it is stricter (mostly for anchors). It also records all redirects, which should eventually be replaced by proper links. Change-Id: Ibed74b9f820c17a5984a78f4f61153e0499453fa
24 lines
670 B
INI
24 lines
670 B
INI
[tox]
|
|
minversion = 1.6
|
|
envlist = docs
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python3
|
|
usedevelop = True
|
|
deps = -r{toxinidir}/requirements.txt
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:linkcheck]
|
|
# redirects and broken links are recorded in doc/build/html/output.txt
|
|
commands = sphinx-build -j auto -d doc/build/doctrees -b linkcheck doc/source doc/build/html
|
|
|
|
[testenv:spelling]
|
|
commands = sphinx-build -j auto -W -d doc/build/doctrees -b html -b spelling doc/source doc/build/html
|
|
|
|
[testenv:docs]
|
|
commands = sphinx-build -j auto -W -d doc/build/doctrees -b html doc/source doc/build/html
|
|
whereto doc/source/_extra/.htaccess doc/test/redirect-tests.txt
|