⚡ Use warnings as errors in python api docs build#46
Open
simonrainerson wants to merge 1 commit into
Open
Conversation
rasuttmus
approved these changes
May 13, 2026
Member
rasuttmus
left a comment
rasuttmus
left a comment
There was a problem hiding this comment.
Nice! Broken docs has annoyed me for quite some time 😸
Comment on lines
+12
to
+13
| - python: Building API docs now runs with warnings as errors, can be | ||
| disabled with strictDocsBuild=false. |
Member
There was a problem hiding this comment.
Guess this should go under "Unreleased"
This makes the build of the docs fail on warnings, there is a -n (--nitpicky) flag as well but from the description this seems a bit overkill. This combination of short and long format flags seems to work best across many versions of sphinx. --keep-going (default in "newer" versions) makes it keep going so it produces all the warnings before exiting with 1, instead of failing on the first one.
simonrainerson
force-pushed
the
python-strict-docs
branch
from
11688e6 to
6b7b967
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This makes the build of the docs fail on warnings, there is a -n
(--nitpicky) flag as well but from the description this seems a bit
overkill. This combination of short and long format flags seems to work
best across many versions of sphinx.
--keep-going (default in "newer" versions) makes it keep going so it
produces all the warnings before exiting with 1, instead of failing
on the first one.