🚑 Make Sphinx nitpicky about broken references

Fixes #2424
pypa · Oct 15, 2020 · b170eac · b170eac
1 parent ff5d8c4
commit b170eac
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -146,3 +146,7 @@
         ],
     ),
 }
+
+
+# Be strict about any broken references:
+nitpicky = True
diff --git 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