Skip to content
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

Suggestion to treat warnings as errors in sphinx-build #256

Merged
merged 9 commits into from
Aug 14, 2024
Merged

Suggestion to treat warnings as errors in sphinx-build #256

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bd747fd
Stop sphinx-build on warning
sfmig Aug 5, 2024
43db82d
Merge branch 'main' into smg/sphinx-doc-stop-on-warning
sfmig Aug 8, 2024
4c6fa7f
Merge branch 'main' into smg/sphinx-doc-stop-on-warning
sfmig Aug 13, 2024
f9d4a79
Add clarification to workflow
sfmig Aug 13, 2024
2d553c9
Add flags to contributing guide
sfmig Aug 13, 2024
5594356
Merge branch 'main' into smg/sphinx-doc-stop-on-warning
sfmig Aug 13, 2024
3eba3fd
Remove comment in workflow file
sfmig Aug 14, 2024
9849f28
Move flags to SPHINXOPTS
sfmig Aug 14, 2024
8aa8feb
Merge branch 'main' into smg/sphinx-doc-stop-on-warning
sfmig Aug 14, 2024
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
4 changes: 3 additions & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ clean:

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
# -W: if there are warnings, treat them as errors and exit with status 1.
# --keep-going: run sphinx-build to completion and exit with status 1 if errors.
%: Makefile api_index.rst
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -W --keep-going
Loading