Skip to content

Commit 20a5682

Browse files
committed
CHANGES(docs): note sphinx autodoc fixes
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
1 parent 4527b7f commit 20a5682

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CHANGES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ $ uvx --from 'vcspull' --prerelease allow vcspull
3131

3232
<!-- Maintainers, insert changes / features for the next release here -->
3333

34+
### Documentation
35+
36+
#### Fix Sphinx autodoc indentation errors (#490)
37+
38+
- Configure `sphinx-autodoc-typehints` to prevent RST parsing conflicts with
39+
Napoleon-processed docstrings by disabling type injection into docstring
40+
bodies (`always_document_param_types`, `typehints_document_rtype`).
41+
- Suppress cosmetic forward reference warnings from TYPE_CHECKING imports.
42+
3443
_Upcoming changes will be written here._
3544

3645
## vcspull v1.48.0 (2025-11-30)

0 commit comments

Comments
 (0)