---
id: annotated-doc
version: "0.0.5"
license: MIT
license_treatment: permissive
maintenance: active
---

# annotated-doc — Document parameters, class attributes, return types, and variables inline, with Annotated.

License: permissive · Maintenance: active · Popularity: top 100 on PyPI

## Install

pip install annotated-doc
uv add annotated-doc
poetry add annotated-doc

## Description

# Annotated Doc

Document parameters, class attributes, return types, and variables inline, with `Annotated`.

<a href="https://github.com/fastapi/annotated-doc/actions?query=workflow%3ATest+event%3Apush+branch%3Amain" target="_blank">
    <img src="https://github.com/fastapi/annotated-doc/actions/workflows/test.yml/badge.svg?event=push&branch=main" alt="Test">
</a>
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/annotated-doc" target="_blank">
    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/annotated-doc.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/annotated-doc" target="_blank">
    <img src="https://img.shields.io/pypi/v/annotated-doc?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypi.org/project/annotated-doc" target="_blank">
    <img src="https://img.shields.io/pypi/pyversions/annotated-doc.svg?color=%2334D058" alt="Supported Python versions">
</a>

## Installation

```bash
pip install annotated-doc
```

Or with `uv`:

```Python
uv add annotated-doc
```

## Usage

Import `Doc` and pass a single literal string with the documentation for the specific parameter, class...

## AI interpretation — verify before relying

Provides a lightweight way to document function parameters, class attributes, return types, and variables using Python's `Annotated` type hint syntax instead of traditional docstrings.

Verdict: A lightweight, actively maintained library with no dependencies that brings inline documentation to Python type hints. Ideal for FastAPI, Typer, and similar frameworks where parameter documentation lives close to its definition. MIT-licensed and widely compatible across current Python versions.

[View on SkillFed](https://skillfed.io/packages/annotated-doc) · [View on PyPI](https://pypi.org/project/annotated-doc/)