How does it handle private members or missing docstrings?

By default, it skips private members (those with a leading underscore) and handles missing docstrings gracefully by noting 'No description provided' while still documenting the code structure.

Does this skill support different docstring formats?

Yes, it supports Google, NumPy, and Sphinx docstring formats to ensure compatibility with your existing coding standards.

Does it require external Python dependencies?

No, it primarily uses Python's standard library modules like 'ast' and 'inspect' for parsing and introspection, requiring no extra packages.

Can it process multiple files at once?

Absolutely. You can provide a single file path, a directory path for recursive processing, or a specific list of Python files.

Python Documentation Generator

Name: Python Documentation Generator
Author: basher83

bybasher83

•

学習とドキュメンテーション

Generates comprehensive Markdown documentation and API references directly from Python source code, docstrings, and type hints.

概要

The Python Documentation Generator skill automates the creation of technical documentation by intelligently parsing Python files using AST and inspection. It extracts module-level details, class definitions, method signatures, and function descriptions to produce clean, hierarchical Markdown files. Whether you need to generate a project README, create detailed API documentation, or extract usage examples from docstrings, this skill ensures your codebase remains well-documented with minimal manual effort, supporting standard formats like Google, NumPy, and Sphinx.

主な機能

Support for Google, NumPy, and Sphinx docstring formats
Recursive directory processing for entire codebases
5 GitHub stars
Hierarchical organization of modules, classes, and functions
Automated Markdown generation from Python source files
Extraction of docstrings, type hints, and code structures

ユースケース

Converting inline code comments and docstrings into readable external documentation
Automatically creating or updating README files from source code
Generating professional API reference documentation for Python libraries

概要

主な機能

Support for Google, NumPy, and Sphinx docstring formats
Recursive directory processing for entire codebases
5 GitHub stars
Hierarchical organization of modules, classes, and functions
Automated Markdown generation from Python source files
Extraction of docstrings, type hints, and code structures

ユースケース

Converting inline code comments and docstrings into readable external documentation
Automatically creating or updating README files from source code
Generating professional API reference documentation for Python libraries