{"categories":[{"label":"Software Development","url":"https://skillfed.io/packages/category/software-development/17"},{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/11"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Griffe extension that enables inline documentation of function parameters, class attributes, return types, and variables using Python's Annotated type hint, following PEP 727 conventions.","skillfed_tags":["pep-727","mkdocs-plugin","type-hints"],"use_cases":["Document function parameters inline using Annotated without writing separate docstring descriptions","Add structured metadata to class attributes that gets rendered in generated API documentation","Maintain documentation closer to type definitions for better code-documentation alignment","Generate richer API docs in MkDocs projects that already use mkdocstrings","Adopt PEP 727 conventions in a codebase to standardize documentation metadata format"],"what_it_does":"Griffe TypingDoc is a plugin for the Griffe documentation tool that extends mkdocstrings to support PEP 727 inline documentation metadata. It allows developers to document function parameters, class attributes, return types, and module-level variables directly within their type hints using Python's Annotated type, rather than relying solely on docstrings. This approach keeps documentation closer to the code and enables richer, more structured metadata.\n\nThe extension integrates into the mkdocstrings Python handler as a configuration option, processing Annotated hints during documentation generation. It depends on griffelib for core functionality and typing-extensions for compatibility across Python versions. The package is actively maintained and supports modern Python versions from 3.10 onward.","worth_installing":"Yes, if you use MkDocs with mkdocstrings and want to adopt PEP 727 inline documentation metadata. Low install friction, active maintenance, permissive license, and no known vulnerabilities make it safe to adopt. Not relevant if you don't use mkdocstrings or prefer traditional docstring-only documentation."},"id":"griffe-typingdoc","links":{"html":"https://skillfed.io/packages/griffe-typingdoc","md":"https://skillfed.io/packages/griffe-typingdoc.md","pypi":"https://pypi.org/project/griffe-typingdoc/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-02-20","license_spdx":"ISC","license_treatment":"permissive","name":"griffe-typingdoc","python_support":"supports_current","summary":"Griffe extension for PEP 727 \u2013 Documentation Metadata in Typing."},"popularity":{"monthly_downloads":88007,"position":13755,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.3.1"}
