feat: treat Sphinx docs warnings as errors (#648)

This PR changes the Sphinx configuration to treat warnings as errors, which helps to detect documentation issues in CI tests.
jenstroeger · Nov 21, 2023 · fe5b8e3 · fe5b8e3
1 parent 72ef227
commit fe5b8e3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,9 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+
+# Treat the warnings as errors.
+SPHINXOPTS    ?= -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build