TopRank Skills

Home / Claw Skills / Git / GitHub / auto-doc-ai
Official OpenClaw rules 36%

auto-doc-ai

基于 AST 和 LLM 自动生成 Python 代码文档(Google Style docstring)。 自动分析代码结构,生成符合 Google Style 的 docstring。

Stars

0

Installs

0

Status

ACTIVE

Visibility

PUBLIC

安装方式

直接复制以下提示词,发送给你的 AI 助手即可完成安装。

请先检查是否已安装 SkillHub 商店,若未安装,请根据 https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/skillhub.md 安装 SkillHub 商店,然后安装 auto-doc-ai 技能。 若已安装,则直接安装 auto-doc-ai 技能。

Overview

Skill Key
antonia-sz/auto-doc-ai
Author
antonia-sz
Source Repo
openclaw/skills
Version
1.0.0
Source Path
skills/antonia-sz/auto-doc-ai
Latest Commit SHA
87a7c73914ff9e1f09186427e91599360e44c49e

Extracted Content

SKILL.md excerpt

# Auto Doc AI — 智能代码文档生成器

自动分析 Python 代码结构,生成符合 Google Style 的 docstring 文档。

## 功能特性

- 🔍 基于 AST 解析代码结构
- 🤖 智能函数/类/方法分析
- 📝 生成 Google Style docstring
- 📁 支持单文件或整个目录批量处理
- 🔄 支持增量更新(跳过已有文档的函数)

## 使用方法

### 为单个文件生成文档

```bash
/generate-docs /path/to/your_script.py
```

### 为整个目录生成文档

```bash
/generate-docs /path/to/src/ --recursive
```

### 强制更新已有文档

```bash
/generate-docs /path/to/src/ --overwrite
```

### 预览模式(不写入文件)

```bash
/generate-docs /path/to/your_script.py --dry-run
```

## 生成的文档格式示例

```python
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

README excerpt

# Auto Doc AI

基于 AST 和 LLM 自动生成 Python 代码文档(Google Style docstring)

## 功能特性

- 🔍 基于 AST 解析代码结构
- 🤖 智能函数/类/方法分析
- 📝 生成 Google Style docstring
- 📁 支持单文件或整个目录批量处理
- 🔄 支持增量更新(跳过已有文档的函数)

## 安装

作为 OpenClaw Skill 使用:
```bash
clawhub install auto-doc-ai
```

或直接使用:
```bash
git clone https://github.com/kimi-claw/skill-auto-doc-ai.git
cd skill-auto-doc-ai
./bin/generate-docs --help
```

## 使用方法

### 为单个文件生成文档

```bash
/generate-docs /path/to/your_script.py
```

### 为整个目录生成文档

```bash
/generate-docs /path/to/src/ --recursive
```

### 强制更新已有文档

```bash
/generate-docs /path/to/src/ --overwrite
```

### 预览模式(不写入文件)

```bash
/generate-docs /path/to/your_script.py --dry-run
```

## 生成的文档格式示例

```python
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

## License

MIT

Related Claw Skills

heyixuan2

bambu-studio-ai

★ 41

Bambu Lab 3D printer control and automation. Activate when user mentions: printer status, 3D printing, slice, analyze model, generate 3D, AMS filament, print monitor, Bambu Lab, or any 3D printing task. Full pipeline: search → generate → analyze → colorize → preview → open BS → user slice → print → monitor. Supports all 9 Bambu Lab printers (A1 Mini, A1, P1S, P2S, X1C, X1E, H2C, H2S, H2D).

capt-marbles

geo-optimization

★ 1

Generative Engine Optimization (GEO) for AI search visibility. Optimize content to appear in ChatGPT, Perplexity, Claude, and Google AI Overviews. Use when optimizing websites, pages, or content for LLM discoverability and citation.

carlulsoe

parakeet-stt

★ 0

Local speech-to-text with NVIDIA Parakeet TDT 0.6B v3 (ONNX on CPU). 30x faster than Whisper, 25 languages, auto-detection, OpenAI-compatible API. Use when transcribing audio files, converting speech to text, or processing voice recordings locally without cloud APIs.

carlzhao007

feishu-process-feedback

★ 0

飞书消息自动处理与进度反馈技能。安装后后台运行,监听飞书任务消息并自动创建独立进程处理。 在处理前后发送实时进度反馈(任务确认、进度百分比、完成通知)。 支持任务类型识别、智能解析、错误重试、并发控制、状态持久化。 使用场景:飞书自动化工作流、任务进度追踪、批量任务处理、需要实时反馈的场景。

cartoonitunes

bottyfans

★ 0

BottyFans agent skill for autonomous creator monetization. Lets AI agents register, build a profile, publish posts (public, subscriber-only, or pay-to-unlock), upload media, accept USDC subscriptions and tips on Base, send and receive DMs, track earnings, and appear on the creator leaderboard. Use this skill when an agent needs to monetize content, interact with fans, manage a creator profile, handle payments in USDC, or operate as an autonomous creator on the BottyFans platform.

camopel

arxivkb

★ 0

Local arXiv paper manager with semantic search. Crawls arXiv categories, downloads PDFs, chunks content, and indexes with FAISS + Ollama embeddings. No cloud API keys required — everything runs locally.