Skip to content

Commit

Permalink
Document warning types
Browse files Browse the repository at this point in the history
  • Loading branch information
aeisenbarth committed Mar 4, 2024
1 parent c22c852 commit f309ae6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ The following configuration options are accepted:
code or `None` to fall back to the default formatter.
- `typehints_use_signature` (default: `False`): If `True`, typehints for parameters in the signature are shown.
- `typehints_use_signature_return` (default: `False`): If `True`, return annotations in the signature are shown.
- `suppress_warnings`: sphinx-autodoc-typehints supports to suppress warning messages via Sphinx's `suppress_warnings`. It allows following additional warning types:
- `sphinx_autodoc_typehints`
- `sphinx_autodoc_typehints.local_function`
- `sphinx_autodoc_typehints.guarded_import`
- `sphinx_autodoc_typehints.forward_reference`
- `sphinx_autodoc_typehints.comment`

## How it works

Expand Down

0 comments on commit f309ae6

Please sign in to comment.