Skip to content

Make Sphinx fail rendering on any warning #3272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2023
Merged

Make Sphinx fail rendering on any warning #3272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
177b3ca
Make Sphinx fail rendering on any warning
AA-Turner Aug 5, 2023
28368dc
Write warnings to ``sphinx-warnings.txt``
AA-Turner Aug 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ BUILDER = html
JOBS = 8
SOURCES =
OUTPUT_DIR = build
SPHINXERRORHANDLING =
SPHINXERRORHANDLING = -W --keep-going -w sphinx-warnings.txt

ALLSPHINXOPTS = -b $(BUILDER) -j $(JOBS) \
$(SPHINXOPTS) $(SPHINXERRORHANDLING) . $(OUTPUT_DIR) $(SOURCES)
Expand All @@ -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
Expand Down