auto-doc-ai — Автоматическая генерация docstring’ов для Python кода
Auto-doc-AI решает проблему отсутствия актуальной документации в Python-проектах, автоматически генерируя Google-стиль docstring'ов и сохраняя версии навыков в Clawhub. Инструмент позволяет быстро и эффективно документировать код, экономя время разработчиков и повышая читаемость проектов. Это удобный CLI-инструмент для автоматизации рутинных задач.
В основе работы лежит анализ абстрактного синтаксического дерева (AST) Python-кода. Auto-doc-AI – это терминальная утилита, предоставляющая простой интерфейс для генерации документации, включая аргументы, возвращаемые значения и исключения, в соответствии с общепринятым Google-стилем. Поддерживается рекурсивная обработка директорий и режим "dry-run" для предварительного просмотра изменений.
Использование Auto-doc-AI осуществляется через командную строку. Пример: /generate-docs /path/to/your_script.py. Инструмент совместим с Python 3.7 и выше, а также интегрируется с Clawhub для удобного хранения и обмена навыками. Доступна опция --overwrite для перезаписи существующих docstring'ов.
$ ls -R related_skills/
npx skills add https://github.com/openclaw/skills/tree/main/skills/antonia-sz/auto-doc-ai
[HINT] Скачивает всю директорию скилла с GitHub: SKILL.md и все связанные файлы