api-docs

Generates Markdown or OpenAPI documentation from source code docstrings and type annotations.

4|2|Updated Jan 27, 2026
One-click install
npx skills add https://github.com/Arete-Consortium/ai-skills --skill api-docs-arete-consortium
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/Arete-Consortium/ai-skills/tree/main/personas/engineering/api-docs
Command: npx skills add https://github.com/Arete-Consortium/ai-skills --skill api-docs-arete-consortium

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining API documentation by hand is tedious and quickly drifts out of sync with the actual code. This Skill parses your source code, docstrings, and type annotations to produce accurate API reference documentation automatically. ## Core Features & Use Cases - Automatic API Discovery: Finds public modules, classes, and functions (excluding underscore-prefixed internals) and extracts their signatures. - Multi-Style Docstring Parsing: Supports Google, NumPy, and Sphinx docstring styles, extracting parameters, return values, raised exceptions, and examples. - Multiple Output Formats: Generates structured Markdown API references with tables of contents, or OpenAPI 3.0 specs for REST endpoints. - Use Case: Point it at a Python module before a release to produce a complete docs/api.md reference with parameter tables, return types, and usage examples pulled from docstrings and tests. ## Quick Start Ask Claude to generate API documentation for a specific module or the whole project, optionally specifying markdown or openapi as the output format.

Frequently Asked Questions about 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?▼

Invoke the skill on a module or the whole project, and it parses public functions and classes, reads Google, NumPy, or Sphinx style docstrings, and outputs a structured Markdown reference with parameter and return type tables.

How to generate an OpenAPI spec from code?▼

Run the skill with the openapi format option to produce an OpenAPI 3.0 YAML spec describing paths, parameters, request schemas, and response objects inferred from your REST endpoint code.

Which docstring styles are supported for API documentation?▼

The skill supports Google, NumPy, and Sphinx docstring styles. It detects the style automatically and extracts sections like Args, Returns, Raises, and Examples into the generated documentation.

Does the documentation include private functions?▼

No. The skill only documents the public API, meaning modules, classes, and functions without a leading underscore prefix. Internal helpers prefixed with an underscore are excluded from the output.

Where do usage examples in the generated docs come from?▼

Examples are pulled from docstring example sections when present, or inferred from test files that exercise the documented functions. This keeps examples aligned with actual usage patterns in the codebase.