Skip to content

Commit a51da3e

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

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,9 @@
120120

121121
# sphinx-autodoc-typehints
122122
autodoc_typehints = "signature"
123+
# When autodoc_typehints = "signature", disable parameter type injection
124+
# to prevent RST indentation conflicts with Napoleon-processed docstrings
125+
always_document_param_types = False
123126

124127
# sphinx.ext.napoleon
125128
napoleon_google_docstring = True

0 commit comments

Comments
 (0)