Standardize Google-style docstrings for Python modules, classes, and functions.
npx skills add https://github.com/arinbalyan/config --skill documentation-arinbalyan
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/arinbalyan/config/tree/main/skills/documentation Command: npx skills add https://github.com/arinbalyan/config --skill documentation-arinbalyan
This Skill standardizes Google-style docstrings and comprehensive project documentation, reducing ambiguity and enabling faster onboarding and API understanding.
Apply Google-style docstring templates to a Python project, covering modules, classes, and functions; integrate with Sphinx or MkDocs.
High-intent search queries and answers about installing and using this skill.
Google-style docstrings standardize Python project documentation by enforcing templates for modules, classes, and functions including Description, Args, Returns, Raises, and Examples. This reduces ambiguity and accelerates API understanding.
The best way to generate API documentation from Python docstrings is integrating Sphinx or MkDocs. These tools parse standardized Google-style docstrings to build comprehensive API references and README files for your project.
Yes, this documentation approach works with both MkDocs and Sphinx. It supports integrating with either tool to generate README files and API references directly from your standardized Python docstrings.
Include architecture diagrams in your API documentation using Mermaid diagrams. This visualizes complex system architectures directly within your project documentation generated by Sphinx or MkDocs.
Yes, you can write doctest-ready examples in Python function docstrings. Standardized Google-style docstrings include an Examples section, ensuring your code documentation remains executable and testable via doctest.
ricardorocheEnforce Google-style docstrings for Python functions and classes.
JongsixGenerate technical documentation from source code and API definitions.
jacexhConfigure ruff, mypy, black, and Google-style docstrings for Python projects.
nilecuiGenerate PyTorch-style docstrings for Python functions and methods.
