Skip to content

Commit 7c792e9

Browse files
committed
Add type annotations to the description instead of signature
This configures Sphinx autodoc to include the type annotations along with the description of the function/method, instead of including it into the signature. Fix #8405
1 parent 19a2f74 commit 7c792e9

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/en/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
# sys.path.insert(0, os.path.abspath('.'))
3636

3737
autodoc_member_order = "bysource"
38+
autodoc_typehints = "description"
3839
todo_include_todos = 1
3940

4041
# -- General configuration -----------------------------------------------------

0 commit comments

Comments
 (0)