Skip to content

Commit 87f1ce3

Browse files
aeisenbarthfajpunk
authored andcommitted
Document warning types
1 parent 0822232 commit 87f1ce3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ The following configuration options are accepted:
8989
code or `None` to fall back to the default formatter.
9090
- `typehints_use_signature` (default: `False`): If `True`, typehints for parameters in the signature are shown.
9191
- `typehints_use_signature_return` (default: `False`): If `True`, return annotations in the signature are shown.
92+
- `suppress_warnings`: sphinx-autodoc-typehints supports to suppress warning messages via Sphinx's `suppress_warnings`. It allows following additional warning types:
93+
- `sphinx_autodoc_typehints`
94+
- `sphinx_autodoc_typehints.comment`
95+
- `sphinx_autodoc_typehints.forward_reference`
96+
- `sphinx_autodoc_typehints.guarded_import`
97+
- `sphinx_autodoc_typehints.local_function`
9298

9399
## How it works
94100

0 commit comments

Comments
 (0)