Turn Sphinx warnings into errors (#1809)

srittau · web-flow · commit dc105feed71a · 2024-07-17T06:30:14.000-07:00
This will – for example – prevent "floating" documents that
aren't part of the TOC structure.
diff --git a/docs/Makefile b/docs/Makefile
@@ -10,7 +10,7 @@ PYTHON       = python3
 VENVDIR      = ./venv
 SPHINXBUILD  = PATH=$(VENVDIR)/bin:$$PATH sphinx-build
 
-ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
+ALLSPHINXOPTS = -W -b $(BUILDER) -d build/doctrees $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
 
 .PHONY: help clean build html text venv Makefile
 
diff --git a/docs/make.bat b/docs/make.bat
@@ -25,7 +25,7 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+%SPHINXBUILD% -W -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
 :help

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ if errorlevel 9009 (`
`25`	`25`	`exit /b 1`
`26`	`26`	`)`
`27`	`27`
`28`		`-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%`
	`28`	`+%SPHINXBUILD% -W -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%`
`29`	`29`	`goto end`
`30`	`30`
`31`	`31`	`:help`