iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make Sphinx fail rendering on any warning (#3272)

This commit is contained in:
Adam Turner 2023-08-05 23:45:23 +01:00 committed by GitHub
parent 2b53c224d1
commit 4a024e1ea1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -9,7 +9,7 @@ JOBS = 8
SOURCES = SOURCES =
# synchronise with render.yml -> deploy step # synchronise with render.yml -> deploy step
OUTPUT_DIR = build OUTPUT_DIR = build
SPHINXERRORHANDLING = SPHINXERRORHANDLING = -W --keep-going -w sphinx-warnings.txt
ALLSPHINXOPTS = -b $(BUILDER) -j $(JOBS) \ ALLSPHINXOPTS = -b $(BUILDER) -j $(JOBS) \
$(SPHINXOPTS) $(SPHINXERRORHANDLING) . $(OUTPUT_DIR) $(SOURCES) $(SPHINXOPTS) $(SPHINXERRORHANDLING) . $(OUTPUT_DIR) $(SOURCES)
@ -30,11 +30,6 @@ dirhtml: BUILDER = dirhtml
dirhtml: venv dirhtml: venv
$(SPHINXBUILD) $(ALLSPHINXOPTS) $(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 ## check-links to check validity of links within PEP sources
.PHONY: check-links .PHONY: check-links
check-links: BUILDER = linkcheck check-links: BUILDER = linkcheck