Doc fixes #490
Merged
Doc fixes #490
Conversation
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
why: sphinx-autodoc-typehints injecting :type: fields causes RST "Unexpected indentation" errors with Napoleon-processed docstrings what: - Set always_document_param_types = False - Complements existing autodoc_typehints = "signature" setting
why: Injected :rtype: fields cause RST parsing conflicts with Napoleon-processed docstrings what: - Set typehints_document_rtype = False - Ensures all type hints appear in signature only, not docstring body
why: Types in TYPE_CHECKING blocks for circular import avoidance generate cosmetic warnings that clutter build output what: - Add suppress_warnings list with forward_reference filter
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #490 +/- ##
==========================================
+ Coverage 78.81% 79.24% +0.42%
==========================================
Files 14 15 +1
Lines 1940 1980 +40
Branches 404 404
==========================================
+ Hits 1529 1569 +40
Misses 267 267
Partials 144 144 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
added a commit
that referenced
this pull request
Dec 6, 2025
why: Document the sphinx-autodoc-typehints configuration changes that fix "Unexpected indentation" errors in documentation build what: - Add Documentation section to v1.49.x unreleased - Note the param/rtype injection and forward reference fixes
Member
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code |
…ypehints why: Types in TYPE_CHECKING blocks (used for circular import avoidance) cause sphinx-autodoc-typehints to emit warnings about unresolvable forward references. These warnings are expected and safe to suppress. what: - Add suppress_warnings config for sphinx_autodoc_typehints.forward_reference
why: Document the sphinx-autodoc-typehints configuration changes that fix "Unexpected indentation" errors in documentation build what: - Add Documentation section to v1.49.x unreleased - Note the param/rtype injection and forward reference fixes
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.
No description provided.