Skip to content

Commit f2a8333

Browse files
committed
docs/conf.py(fix): disable rtype injection for autodoc
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
1 parent a51da3e commit f2a8333

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@
123123
# When autodoc_typehints = "signature", disable parameter type injection
124124
# to prevent RST indentation conflicts with Napoleon-processed docstrings
125125
always_document_param_types = False
126+
# Disable return type injection in docstrings (types shown in signature only)
127+
typehints_document_rtype = False
126128

127129
# sphinx.ext.napoleon
128130
napoleon_google_docstring = True

0 commit comments

Comments
 (0)