docs: enable nitpicky mode to warn on broken references#2668
Open
krusta07 wants to merge 4 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2668 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7985 7985
Branches 1103 1103
=========================================
Hits 7985 7985 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vytas7
requested changes
Jul 13, 2026
vytas7
left a comment
Member
There was a problem hiding this comment.
Hi, and thanks for experimenting with this.
Unfortunately, bluntly enabling nitpicky like this results in hundreds of warnings...
vytas7
requested changes
Jul 13, 2026
| # Intersphinx configuration | ||
| intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} | ||
|
|
||
| # NOTE(vytas): Nitpicky mode is enabled to warn on broken references and |
Member
There was a problem hiding this comment.
Please do not impersonate me in the comments, use your own nick in the prefix.
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
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.
Summary of Changes
Enabled nitpicky = True in docs/conf.py so Sphinx emits
warnings on broken references during documentation builds.
Also added nitpick_ignore entries for the three unresolved
type aliases (SyncMiddleware, AsyncMiddleware,
PreparedMiddlewareResult) that were already noted in a
TODO comment in the same file.
Related Issues
Closes #1888
Pull Request Checklist