# Doc Generator

> Auto-generate API reference documentation from Python code.

- Skill: `xspoonai/doc-generator` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add xspoonai/doc-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/xspoonai/doc-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: XSpoonAi (https://skillmd.com/u/xspoonai)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/xspoonai/doc-generator

---


# Documentation Generator

A high-impact skill that parses Python source code and generates a standardized Markdown API reference. It utilizes AST parsing to extract docstrings, function signatures, and class structures.

## Quick Start

```python
# Generate docs for a file
result = await agent.run_tool("generate_docs", file_path="src/client.py")
print(result)
```

## Scripts

| Script | Purpose |
|--------|---------|
| [doc_gen.py](scripts/doc_gen.py) | Generates Markdown documentation from Python files |

## Environment Variables

None required. Uses standard library `ast`.

## Best Practices

1. Ensure your code has partial docstrings for better output.
2. Use this to keep `README.md` or `API.md` up to date automatically.