pydox

Local-first Python documentation generator. Extracts docstrings + signatures, outputs clean Markdown.

A lightweight CLI tool that generates API documentation from your Python code. No cloud, no API costs, no setup.

Why pydox?

• ✅ No API costs: Pure static analysis, runs entirely on your machine
• ✅ No cloud: Your code never leaves your computer
• ✅ Fast: Analyzes thousands of files in seconds
• ✅ Simple output: Clean Markdown, ready for MkDocs/Docusaurus
• ✅ Open source: MIT license, code on GitHub

Installation

pipx install pydox

Or with pip:

pip install --user pydox

Usage

# Document current directory
pydox generate

# Document specific file
pydox generate mymodule.py

# Document a directory and save to file
pydox generate ./src --output docs/API.md

# Generate an index file (summary table)
pydox generate ./src --index --output docs/

Output example

For a file like:

def hello_world(name: str) -> str:
    """Greet someone by name.
    
    Args:
        name: The name to greet.
    
    Returns:
        A greeting string.
    """
    return f"Hello, {name}!"

pydox generates:

# `mymodule.py`

## Functions

### `def hello_world(name: str) -> str`

Greet someone by name.

**Args:**
- `name`: The name to greet.

**Returns:**
A greeting string.

Pricing

License

MIT