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

•

Learning & Documentation

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.

Key Features

01Support for Google, NumPy, and Sphinx docstring formats

02Recursive directory processing for entire codebases

035 GitHub stars

04Hierarchical organization of modules, classes, and functions

05Automated Markdown generation from Python source files

06Extraction of docstrings, type hints, and code structures

Use Cases

01Converting inline code comments and docstrings into readable external documentation

02Automatically creating or updating README files from source code

03Generating professional API reference documentation for Python libraries

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add basher83/lunar-claude doc-generator

For use in Claude.ai and ChatGPT

Key Features

01Support for Google, NumPy, and Sphinx docstring formats

02Recursive directory processing for entire codebases

035 GitHub stars

04Hierarchical organization of modules, classes, and functions

05Automated Markdown generation from Python source files

06Extraction of docstrings, type hints, and code structures

Use Cases

01Converting inline code comments and docstrings into readable external documentation

02Automatically creating or updating README files from source code

03Generating professional API reference documentation for Python libraries

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add basher83/lunar-claude doc-generator

For use in Claude.ai and ChatGPT