Skip to content

Commit 7074d6a

Browse files
committed
docs(conf): Add always_document_param_types config
why: Ensure consistent parameter documentation in autodoc output what: - Add always_document_param_types = True for sphinx-autodoc-typehints
1 parent f651d52 commit 7074d6a

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@
118118
autodoc_class_signature = "separated"
119119
toc_object_entries_show_parents = "hide"
120120

121+
# sphinx-autodoc-typehints
122+
always_document_param_types = True
123+
121124
# sphinx-copybutton
122125
copybutton_prompt_text = (
123126
r">>> |\.\.\. |> |\$ |\# | In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "

0 commit comments

Comments
 (0)