Make the Sphinx configuration stricter (#249)

jstasiak · web-flow · commit b6507fcdec47 · 2026-01-29T14:57:48.000+01:00
Previously some warnings (including but not limited to broken
referenced) could pass unnoticed, not anymore.
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,6 +15,9 @@
 
 extensions = []
 
+# Warn on broken references
+nitpicky = True
+
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
 
