← Back to Skills Marketplace
Auto Doc AI
by
antonia huang
· GitHub ↗
· v1.0.0
· MIT-0
297
Downloads
0
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install auto-doc-ai
Description
基于 AST 和 LLM 自动生成 Python 代码文档（Google Style docstring）。 自动分析代码结构，生成符合 Google Style 的 docstring。
README (SKILL.md)
Auto Doc AI — 智能代码文档生成器
自动分析 Python 代码结构，生成符合 Google Style 的 docstring 文档。
功能特性
- 🔍 基于 AST 解析代码结构
- 🤖 智能函数/类/方法分析
- 📝 生成 Google Style docstring
- 📁 支持单文件或整个目录批量处理
- 🔄 支持增量更新（跳过已有文档的函数）
使用方法
为单个文件生成文档
/generate-docs /path/to/your_script.py
为整个目录生成文档
/generate-docs /path/to/src/ --recursive
强制更新已有文档
/generate-docs /path/to/src/ --overwrite
预览模式（不写入文件）
/generate-docs /path/to/your_script.py --dry-run
生成的文档格式示例
def process_data(data, threshold=0.5):
"""处理输入数据并返回过滤后的结果。
Args:
data (list): 输入数据列表。
threshold (float, optional): 过滤阈值，默认为 0.5。
Returns:
list: 过滤后的数据列表。
Raises:
ValueError: 如果数据格式无效。
"""
pass
注意事项
- 仅支持 Python 3.7+ 的文件
- 建议先使用
--dry-run预览生成的文档 - 使用
--overwrite会替换所有现有 docstring
Usage Guidance
This skill's description and docs describe a CLI (/generate-docs) and reference a GitHub repo, but the published package contains only README and SKILL.md — no code, no installer, and no declared LLM credentials. Before installing or enabling this skill: 1) ask the publisher for the implementation/source or a valid install spec (so you know what will be executed); 2) if you plan to let it run on your codebase, prefer dry-run/preview first and avoid --overwrite until you verify output; 3) confirm whether an external LLM/API key is required and where secrets would be stored; 4) if you don't trust the source, do not run arbitrary binaries or git clones suggested by the README. Clarifying these points would reduce the current uncertainty.
Capability Analysis
Type: OpenClaw Skill
Name: auto-doc-ai
Version: 1.0.0
The skill bundle contains documentation (SKILL.md, README.md) and metadata (_meta.json) for a Python docstring generator. The described functionality—parsing code via AST and generating Google-style documentation—is consistent with its stated purpose. No executable code was provided in the snippet, and the instructions for the AI agent contain no evidence of prompt injection, data exfiltration, or malicious intent.
Capability Assessment
Purpose & Capability
The stated purpose (generate Google-style docstrings from Python using AST + LLM) is reasonable and coherent as a concept, but the SKILL.md and README both reference a /generate-docs CLI and a git repo with a binary. The registry entry contains no code files or install spec, so the claimed executable/tool is not actually provided.
Instruction Scope
The runtime instructions tell the agent/user to run /generate-docs against local files or directories (including --overwrite). Operating on local source files is within the stated purpose, but instructions assume a local executable and don't describe how the LLM integration is performed or where any required API keys would come from.
Install Mechanism
There is no install spec in the registry package. README suggests installing from a GitHub repo or via clawhub, implying that additional code/binaries exist upstream — but those are not included here. This mismatch increases uncertainty: the skill may rely on an external binary that won't be present unless the user manually installs it.
Credentials
The skill declares no environment variables or credentials, which is proportional if it intends to use the agent's internal model. However the description explicitly mentions an LLM; if the implementation calls an external LLM API it would normally require API keys (not declared). This absence should be clarified.
Persistence & Privilege
The skill is not marked always:true, and is user-invocable. It does not request persistent privileges or system-wide config changes in the provided files.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install auto-doc-ai - After installation, invoke the skill by name or use
/auto-doc-ai - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of Auto Doc AI — 智能代码文档生成器.
- 自动分析 Python 代码结构，基于 AST 和 LLM 生成 Google Style docstring
- 支持单文件、目录和递归批量处理
- 可选择仅处理缺失文档或强制覆盖全部 docstring
- 支持预览模式（dry-run）避免直接修改文件
- 仅支持 Python 3.7 及以上版本
Metadata
Frequently Asked Questions
What is Auto Doc AI?
基于 AST 和 LLM 自动生成 Python 代码文档（Google Style docstring）。 自动分析代码结构，生成符合 Google Style 的 docstring。 It is an AI Agent Skill for Claude Code / OpenClaw, with 297 downloads so far.
How do I install Auto Doc AI?
Run "/install auto-doc-ai" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Auto Doc AI free?
Yes, Auto Doc AI is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Auto Doc AI support?
Auto Doc AI is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Auto Doc AI?
It is built and maintained by antonia huang (@antonia-sz); the current version is v1.0.0.
More Skills