{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Automatically extracts Python type hints from your code and injects them into Sphinx-generated documentation, eliminating the need to duplicate type information in docstrings.","skillfed_tags":["sphinx-extension","type-hints","api-docs"],"use_cases":["Maintain API documentation for a library without duplicating type information between code and docstrings.","Generate type-annotated docs for attrs or dataclass-heavy projects automatically.","Support multiple docstring styles (Google, NumPy, reStructuredText) while keeping types in sync.","Display @overload signatures in your docs to show all valid function call patterns.","Control union type rendering to match your project's style guide (Union syntax vs pipe syntax)."],"what_it_does":"sphinx-autodoc-typehints is a Sphinx extension that reads Python type annotations from your source code and automatically incorporates them into your generated API documentation. Instead of writing types twice\u2014once in code annotations and again in docstrings\u2014you write them once in your function signatures and let the extension handle the rest. It resolves types from TYPE_CHECKING blocks and .pyi stub files, renders @overload signatures, extracts types from attrs and dataclass classes, and handles both Google and NumPy docstring styles.\n\nThe extension integrates directly into your Sphinx build pipeline through sphinx.ext.autodoc. It offers fine-grained control over how types appear in your output: you can choose union display style (Union[X, Y] vs X | Y), show or hide return types, display default parameter values, and apply custom type formatters. It also automatically fixes cross-references for standard library types whose runtime module differs from their documented path, reducing manual link corrections in your docs.","worth_installing":"Yes. This is a stable, actively maintained extension (release 11 days ago, 587 stars) with low install friction and no known vulnerabilities. It solves a real problem\u2014eliminating type duplication between code and docs\u2014and is widely used (top 5000 on PyPI). MIT license poses no restrictions. Install it if you use Sphinx and want your type hints to flow automatically into your documentation."},"id":"sphinx-autodoc-typehints","links":{"html":"https://skillfed.io/packages/sphinx-autodoc-typehints","md":"https://skillfed.io/packages/sphinx-autodoc-typehints.md","pypi":"https://pypi.org/project/sphinx-autodoc-typehints/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-08-03","license_spdx":"MIT","license_treatment":"permissive","name":"sphinx-autodoc-typehints","python_support":"supports_current","summary":"Type hints (PEP 484) support for the Sphinx autodoc extension"},"popularity":{"monthly_downloads":9483648,"position":1530,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"3.13.2"}