griffe-typingdoc
Griffe extension for PEP 727 – Documentation Metadata in Typing.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; intended for use within a MkDocs project with mkdocstrings configured.
- Low friction install with only two runtime dependencies (griffelib and typing-extensions).
- Actively maintained with recent commits; last release 175 days ago.
License · maintenance · safety
ISC (permissive) — ISC license is permissive, allowing commercial and private use with minimal restrictions.
last release 2026-02-20 (175 days) · last repo commit 2026-08-14 · 21 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 88,007 downloads/mo, #13,755 on PyPI
Alternatives
Verify before relying
pip install griffe-typingdoc
# In mkdocs.yml:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdoc- Whether this extension works with all mkdocstrings handlers or only the Python handler
- Compatibility with existing Griffe plugins and whether conflicts are possible
- Performance impact on documentation generation for large codebases
What it is and 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.
The 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.
Use it for
- 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
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
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.
Install
griffe-typingdoc on PyPI
Before you install
Low friction install with only two runtime dependencies (griffelib and typing-extensions). Actively maintained with recent commits; last release 175 days ago. Supports Python 3.10 through 3.14.
Requires Python 3.10 or later; intended for use within a MkDocs project with mkdocstrings configured.
License in practice
ISC license is permissive, allowing commercial and private use with minimal restrictions.
Quickstart
pip install griffe-typingdoc
# In mkdocs.yml:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdocVerify before relying
- Whether this extension works with all mkdocstrings handlers or only the Python handler
- Compatibility with existing Griffe plugins and whether conflicts are possible
- Performance impact on documentation generation for large codebases
Package facts
| License | ISC permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesgriffelibtyping-extensions |
| Maintenance | Actively maintained 175 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 88,007 / month, #13,755 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software DevelopmentTopic :: Software Development :: DocumentationTopic :: UtilitiesTyping :: Typed |
Evidence: griffe_typingdoc-0.3.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “PEP 727 documentation metadata”
- griffe-typingdocGriffe extension that enables inline documentation of function…
- attributes-docExtracts and stores docstrings for class attributes at runtime,…
- sphinx-pyprojectLoads Sphinx documentation configuration from pyproject.toml instead…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also griffe-warnings-deprecated · typeapi · griffe-pydantic · griffe · mkdocstrings-python · mkdocstrings · mkdocstrings-python-legacy · griffe2md · pytkdocs