generate-api-docs

To generate API documentation from Python docstrings, this Skill parses function signatures, parameters, return types, and exceptions to automatically create HTML or Markdown reference guides for software libraries.

Generating API reference documentation requires valid docstrings in Google, NumPy, or reStructuredText format to successfully extract module interfaces and create output standards for module overviews and cross-references.

Yes, you can create HTML API references from source code using Sphinx or pdoc. This Skill leverages these tools to automate documentation generation by extracting information directly from your code's docstrings.

Generating API docs with this approach works specifically for documenting public module interfaces. It applies to creating reference guides for software libraries by adhering to output standards for module overviews and cross-references.

The best way to automate Python library documentation is using this Skill to extract docstrings and generate a comprehensive API reference guide. This ensures consistency and reduces manual documentation effort when releasing a new library.