Documenting Python Libraries

What it does

This skill automatically generates documentation for Python libraries. It analyzes the library's code and docstrings to produce structured documentation in a standard format, such as reStructuredText or Markdown. The resulting documentation can be used to create API references, tutorials, and other developer resources.

When to use it

• Creating initial documentation: Quickly generate basic documentation for a new Python library project.
• Updating existing documentation: Automatically update documentation when the library's code changes.
• Generating API reference: Produce comprehensive API documentation from docstrings.
• Documenting open-source projects: Help maintainers of open-source libraries keep their documentation up to date.

Key capabilities

• Code analysis
• Docstring parsing
• Documentation generation (reStructuredText, Markdown)
• API reference creation

Example prompts

• "Generate documentation for the 'requests' library."
• "Create an API reference for my 'my_library' project in Markdown format."
• "Update the documentation for the 'utils' module in my project."

Tips & gotchas

The quality of the generated documentation depends heavily on the quality and completeness of the Python library’s docstrings. Ensure your code has well-written docstrings to maximize the effectiveness of this skill.