Generate Api Docs

What it does

This skill automatically generates API documentation from code. It parses code files, extracts function and method signatures, and creates formatted documentation including descriptions, parameters, and return types. The generated documentation can be output in various formats suitable for publishing or integration into developer portals.

When to use it

• Onboarding new developers: Quickly provide clear API reference materials for a team joining a project.
• Automating documentation updates: Keep API docs synchronized with code changes, reducing manual effort and errors.
• Generating internal API references: Create easily accessible documentation for internal APIs used across an organization.
• Creating public developer portals: Produce professional-looking API documentation to share with external developers.

Key capabilities

• Code parsing
• Function/method signature extraction
• Formatted output generation
• Multiple output formats (unspecified)

Example prompts

• "Generate API docs for the my_library directory."
• "Create documentation in Markdown format from the api.py file."
• “Output API documentation for all Python files in this repository.”

Tips & gotchas

The skill's effectiveness depends on well-structured and documented code; poorly formatted code may result in inaccurate or incomplete documentation. Ensure your codebase follows consistent coding conventions for optimal results.