Tutorial¶
Working usage examples¶
Add sphinx_autodoc_typehints_gp to your extensions list in conf.py:
extensions = [
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints_gp",
]
# Required: makes autodoc insert type annotations into parameter descriptions.
# Without this, the type cross-referencing pipeline fires but has nothing to attach to.
autodoc_typehints = "description"