Agent skill · writing content · aiskillstore
doc-generator
Generate markdown documentation from Python codebases by analyzing source files, extracting docstrings, type hints, and code structure. Use when the user asks to document Python code, create API docs, or generate README files from source code.
Why this skill is useful
Adds a specific tool for generating markdown documentation from Python codebases, which includes parsing and extracting structured information that the AI wouldn't reliably generate on its own.
What it needs
About 1k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Python Documentation Generator Generate comprehensive markdown documentation from Python source code. When to Use This Skill User asks to "document this code" or "generate docs" Creating API documentation from Python modules Generating README files with usage examples Extracting docstrings and type signatures into readable format User mentions "documentation", "docstrings", or "API reference" Input Accept either: Single Python file path Directory path (recursively process .py files) List of specific files Output Format Generate standard markdown with: python Extract from docstring examples or generate basic usage Analysis Approach 1. Parse Python files using AST or inspection 2. Extract key elements: Module-level docstrings Class definitions and docstrings Function/method signatures with type hints Docstring content (support Google, NumPy, Sphinx formats) 3. Organize hierarchically (modules -> classes -> methods -> functions) 4. Generate clean markdown with consistent formatting Quality Guidelines Preserve original docstring formatting when meaningful Include type hints prominently in signatures Group related items (all classes together, all functions together) Add table of contents for large modules Skip private members (leading underscore) unless explicitly requested Handle missing docstrings gracefully (note "No description provided") Python Tools Prefer standard library: ast module for parsing inspect module for runtime introspection pathlib for file handling No external dependencies required for basic documentation generation. Error Handling Skip files with syntax errors (log warning) Handle missing type hints gracefully Warn if no docstrings found but continue processing Validate file paths exist before processing
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/doc-generator