summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2023-02-10 12:23:25 -0700
committerNed Batchelder <ned@nedbatchelder.com>2023-02-12 15:03:11 -0500
commitd06ace282bf26c5c7f3becb21db0cdd028ec0d9a (patch)
tree6c3ce2b3ecb59040ac417fc240a94f5e49859735
parent83c038a8aa262a51ecc44eebfc3b19c1fe712222 (diff)
downloadpython-coveragepy-git-d06ace282bf26c5c7f3becb21db0cdd028ec0d9a.tar.gz
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.
-rw-r--r--doc/conf.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 39601fab..9be27efd 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -43,6 +43,8 @@ extensions = [
#'sphinx_tabs.tabs',
]
+autodoc_typehints = "description"
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -126,6 +128,10 @@ intersphinx_mapping = {
nitpick_ignore = [
("py:class", "frame"),
("py:class", "module"),
+ ("py:class", "DefaultValue"),
+ ("py:class", "FilePath"),
+ ("py:class", "TWarnFn"),
+ ("py:class", "TDebugCtl"),
]
nitpick_ignore_regex = [