Skip to content

Commit d06ace2

Browse files
committed
docs: don't show type hints in the signature
List the parameters separately, with type hints. This leaves a list of params with dashes and no description, but we can get to that later.
1 parent 83c038a commit d06ace2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@
4343
#'sphinx_tabs.tabs',
4444
]
4545

46+
autodoc_typehints = "description"
47+
4648
# Add any paths that contain templates here, relative to this directory.
4749
templates_path = ['_templates']
4850

@@ -126,6 +128,10 @@
126128
nitpick_ignore = [
127129
("py:class", "frame"),
128130
("py:class", "module"),
131+
("py:class", "DefaultValue"),
132+
("py:class", "FilePath"),
133+
("py:class", "TWarnFn"),
134+
("py:class", "TDebugCtl"),
129135
]
130136

131137
nitpick_ignore_regex = [

0 commit comments

Comments
 (0)