documenter

Generate API documentation, READMEs, and docstrings in Markdown, reStructuredText, and HTML.

4|Updated Aug 19, 2025
One-click install
npx skills add https://github.com/wtthornton/HomeIQ --skill documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenter
Source: https://github.com/wtthornton/HomeIQ/tree/main/.claude/skills/documenter
Command: npx skills add https://github.com/wtthornton/HomeIQ --skill documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation gaps slow adoption and developer onboarding. This Skill generates consistent API docs, READMEs, and docstrings to improve clarity and maintainability.

Core Features & Use Cases

  • API Documentation: Generates endpoints, parameters, and responses with examples.
  • README Generation: Creates project overviews, usage instructions, and examples.
  • Docstring Updates: Adds or refines docstrings to align with style guides.
  • Context7 Integration: References documentation standards and templates.

Quick Start

Generate API docs for src/api/auth.py in markdown format.

Frequently Asked Questions about documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from Python code?

API documentation extracts endpoint, parameter, and response information from code and formats it with examples. This Skill automates that extraction for Python files, generating markdown, reStructuredText, or HTML output aligned with OpenAPI and Sphinx standards.

Can I use this to create and update README files automatically?

Yes. README generation creates project overviews, usage instructions, and code examples from your codebase. This Skill handles both initial creation and updates to keep documentation synchronized with code changes.

What docstring formats does this support?

Docstring updates support Google, NumPy, and Sphinx styles. The Skill adds or refines docstrings across codebases to align with your chosen format and standardize documentation throughout the project.

Does this work with Markdown, reStructuredText, and HTML?

Yes. This Skill supports Markdown, reStructuredText, and HTML output formats. It applies Context7 standards to maintain consistent style and structure across all documentation output types.

How does this integrate with Sphinx and MkDocs?

Documentation generation leverages Sphinx, MkDocs, and Doxygen patterns using Context7 KB cache. Output aligns with these tools' conventions, allowing seamless integration into existing documentation workflows and build pipelines.

What should I prepare before generating documentation?

Provide your source code files, choose your target format (Markdown, reStructuredText, or HTML), and select a docstring style (Google, NumPy, or Sphinx). The Skill handles extraction and generation from there.