generate-api-docs

Generate browsable HTML API documentation from Python docstrings.

2|Updated Feb 23, 2026
One-click install
npx skills add https://github.com/roach88/claude-config --skill generate-api-docs-roach88
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-api-docs
Source: https://github.com/roach88/claude-config/tree/main/skills/generate-api-docs
Command: npx skills add https://github.com/roach88/claude-config --skill generate-api-docs-roach88

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious, error-prone manual work of writing and maintaining API documentation for Python projects, ensuring docs stay in sync with code changes automatically.

Core Features & Use Cases

  • Multi-tool support: Generate docs using pdoc (default, zero-config for Google-style docstrings), Sphinx (for extensive customization), or MkDocs (for markdown-based documentation workflows).
  • Monorepo compatible: Handle multi-package Python projects, generating either per-package or unified documentation sites as needed.
  • Use Case: For a Python library with 5 interconnected packages, use this Skill to auto-generate a single searchable API reference site with one command, no manual doc writing required.

Quick Start

Use the generate-api-docs skill to create browsable HTML API documentation for the Python package located at packages/my-lib/src using the default pdoc format.

Frequently Asked Questions about generate-api-docs

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

FAQPage Schema
How do I generate API documentation from Python docstrings automatically?

You can generate API documentation from Python docstrings automatically by using a tool that parses existing code to produce browsable HTML output with navigation, search, and module indexing without manual writing.

What is the best way to create browsable API docs for a Python monorepo?

The best way to create API docs for a Python monorepo is to use a generation tool that handles multi-package projects, allowing you to auto-generate either per-package or unified searchable API reference sites with one command.

Does pdoc work with Google-style docstrings out of the box?

Yes, pdoc works with Google-style docstrings natively as a zero-config default option, instantly turning Python code docstrings into browsable HTML API documentation.

Can I use Sphinx or MkDocs instead of pdoc for Python API documentation generation?

Yes, you can use Sphinx for extensive customization or MkDocs for markdown-based documentation workflows, alongside the default pdoc generator, to produce browsable API docs from Python code.

How do I integrate Python API documentation generation into a CI/CD pipeline?

You can integrate Python API documentation generation into a CI/CD pipeline by applying an automated tool that extracts docstrings and outputs HTML documentation during your continuous integration workflow.

Why are my Python API docs out of sync with my code changes?

Python API docs fall out of sync when maintained manually, but you can fix this by automating documentation generation directly from existing code docstrings to ensure they update automatically.