doc-generator

Generate markdown documentation by analyzing your Python codebase with AST parsing to extract module docstrings, class definitions, function signatures with type hints, and docstring content in Google, NumPy, or Sphinx formats, producing structured Markdown covering modules, classes, functions, parameters, returns, and examples.

The skill processes both single Python files and recursively analyzes entire directories, extracting documentation from all modules and classes while preserving type hints and automatically skipping private members unless explicitly requested.

Python documentation generation supports Google, NumPy, and Sphinx docstring formats, parsing and converting each format into consistent structured Markdown output with parameters, returns, type hints, and usage examples clearly documented.

Use the generated markdown documentation directly in API reference guides and project README files, which contain organized module overviews, class hierarchies, function signatures, type information, and usage examples ready for immediate publication or further editing.

Auto-generating documentation from existing docstrings eliminates manual markdown creation and maintenance; documentation stays synchronized with your codebase as you update Python docstrings, class definitions, and function signatures.

Private members are automatically excluded from generated documentation by default, focusing output on public APIs; you can optionally include them if needed for internal or comprehensive reference documentation.