Push sphinx build warnings to nitpicky level #280
Closed
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.
The previous work of #273 was a good first step to finding and fixing broken links/references throughout the docs, and setting up a workflow that will automatically alert the maintainers to such things, but it can get even better.
The nitpicky mode goes a step further when evaluating not only missing section references (including inter-sphinx) but also all API internal references through things like
:py:class:
, which normally just fail silently if a corresponding link cannot be found.