summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSviatoslav Sydorenko <wk@sydorenko.org.ua>2020-10-16 01:09:14 +0200
committerSviatoslav Sydorenko <wk@sydorenko.org.ua>2020-10-16 01:42:12 +0200
commitb170eac3e00f65c3d56d48d5aa8ee18f00a7baf9 (patch)
treefc63ca730907fe02df96a2beea349c90e3943434
parentff5d8c4440df27a6f38384d650a0990459a569c3 (diff)
downloadpython-setuptools-git-b170eac3e00f65c3d56d48d5aa8ee18f00a7baf9.tar.gz
🚑 Make Sphinx nitpicky about broken references
Fixes #2424
-rw-r--r--docs/conf.py4
-rw-r--r--tox.ini11
2 files changed, 14 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index d5111391..1928af58 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -146,3 +146,7 @@ link_files = {
],
),
}
+
+
+# Be strict about any broken references:
+nitpicky = True
diff --git a/tox.ini b/tox.ini
index 535b67d3..828d2c02 100644
--- a/tox.ini
+++ b/tox.ini
@@ -49,7 +49,16 @@ extras =
testing
changedir = docs
commands =
- python -m sphinx . {toxinidir}/build/html
+ {envpython} -m sphinx \
+ -j auto \
+ -b html \
+ --color \
+ -a \
+ -n \
+ -W \
+ -d "{temp_dir}/.doctrees" \
+ . \
+ "{toxinidir}/build/html"
[testenv:finalize]
skip_install = True