docs: enable nitpicky mode to warn on broken references - #2668
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
left a comment
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...
| # Intersphinx configuration | ||
| intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} | ||
|
|
||
| # NOTE(vytas): Nitpicky mode is enabled to warn on broken references and |
There was a problem hiding this comment.
Please do not impersonate me in the comments, use your own nick in the prefix.
|
Hi again @krusta07, I am going to close this pull request for now, since the real work is actually making the nitpicky mode builds pass, not merely enabling the flag. Feel free to submit a new PR if you prototype anything more in this direction. |
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