Skip to content

Change visibility of type hints#66

Merged
AdamRJensen merged 5 commits into
mainfrom
change-typehints-documentation
May 29, 2026
Merged

Change visibility of type hints#66
AdamRJensen merged 5 commits into
mainfrom
change-typehints-documentation

Conversation

@AdamRJensen
Copy link
Copy Markdown
Member

@AdamRJensen AdamRJensen commented May 28, 2026

There are the following options for displaying type hints in the conf.py file:

autodoc_typehints = "none"          # hide all type hints
# or
autodoc_typehints = "description"   # move type hints into parameter descriptions
# or
autodoc_typehints = "signature"     # show in function signature (default-ish behavior)
# or
autodoc_typehints = "both"          # show in both signature and description

@AdamRJensen AdamRJensen merged commit 64e6b75 into main May 29, 2026
19 checks passed
@AdamRJensen AdamRJensen deleted the change-typehints-documentation branch May 29, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant