generate-api-docs
CommunityAuto-generate API docs from your code.
Content & Communication#code generation#technical writing#docstrings#sphinx#api documentation#reference guide#pdoc
Authormvillmow
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Manually creating and maintaining API reference documentation from code docstrings is a time-consuming, repetitive, and often outdated process.
Core Features & Use Cases
- Docstring Extraction: Extracts docstrings from public functions and classes to automatically generate API reference documentation.
- Multi-format Output: Can generate documentation in various formats, including HTML or Markdown.
- Use Case: After developing a new library, use this skill to automatically generate comprehensive API documentation from your code's docstrings, ensuring it's always up-to-date and accessible.
Quick Start
Use the generate-api-docs skill to generate HTML API documentation for 'module_name' using pdoc.
Dependency Matrix
Required Modules
pdocsphinx
Components
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: generate-api-docs Download link: https://github.com/mvillmow/ProjectOdyssey/archive/main.zip#generate-api-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.