From 177b3caa091517b42218cf0baa24e07de9dc68a5 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sat, 5 Aug 2023 13:22:10 +0100 Subject: [PATCH 1/2] Make Sphinx fail rendering on any warning --- Makefile | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 5bcdf07b5fe..f6130c0faf2 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ BUILDER = html JOBS = 8 SOURCES = OUTPUT_DIR = build -SPHINXERRORHANDLING = +SPHINXERRORHANDLING = -W --keep-going ALLSPHINXOPTS = -b $(BUILDER) -j $(JOBS) \ $(SPHINXOPTS) $(SPHINXERRORHANDLING) . $(OUTPUT_DIR) $(SOURCES) @@ -29,11 +29,6 @@ dirhtml: BUILDER = dirhtml dirhtml: venv rss $(SPHINXBUILD) $(ALLSPHINXOPTS) -## fail-warning to render PEPs to "pep-NNNN.html" files and fail the Sphinx build on any warning -.PHONY: fail-warning -fail-warning: venv - $(SPHINXBUILD) $(ALLSPHINXOPTS) -W - ## check-links to check validity of links within PEP sources .PHONY: check-links check-links: BUILDER = linkcheck From 28368dc3273b762806b5663cdca14ec754cbc985 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sat, 5 Aug 2023 17:06:41 +0100 Subject: [PATCH 2/2] Write warnings to ``sphinx-warnings.txt`` --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f6130c0faf2..4f98a48c87c 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ BUILDER = html JOBS = 8 SOURCES = OUTPUT_DIR = build -SPHINXERRORHANDLING = -W --keep-going +SPHINXERRORHANDLING = -W --keep-going -w sphinx-warnings.txt ALLSPHINXOPTS = -b $(BUILDER) -j $(JOBS) \ $(SPHINXOPTS) $(SPHINXERRORHANDLING) . $(OUTPUT_DIR) $(SOURCES)