diff mbox series

[1/1] doc: handle 'make htmldocs' warnings as errors

Message ID 20210801202018.9398-1-xypron.glpk@gmx.de
State Accepted, archived
Commit 89a5fbbea1e344fb7e43ce4c547fbdf1ae8d81de
Delegated to: Heinrich Schuchardt
Headers show
Series [1/1] doc: handle 'make htmldocs' warnings as errors | expand

Commit Message

Heinrich Schuchardt Aug. 1, 2021, 8:20 p.m. UTC
Parameter -W for sphinx-build turns build warnings into errors. This helps
us to avoid bad patches passing Gitlab CI.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.30.2
diff mbox series

Patch

diff --git a/doc/Makefile b/doc/Makefile
index 683e4b5609..050d9dd239 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -6,7 +6,7 @@  subdir-y :=

 # You can set these variables from the command line.
 SPHINXBUILD   = sphinx-build
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXDIRS    = .
 _SPHINXDIRS   = $(patsubst $(srctree)/doc/%/conf.py,%,$(wildcard $(srctree)/doc/*/conf.py))
 SPHINX_CONF   = conf.py