关于 fix-sphix-docs
fix-sphix-docs 是一项迭代构建 Sphinx 文档并尝试修复易处理错误和警告的技能，面向维护文档的开发者。它限制构建等待时间，并避免修改自动生成的 RST 文件。
主要功能
- 01运行 Sphinx HTML 构建
- 02限制构建等待时间
- 03检查构建错误和警告
- 04跳过自动生成的 RST 文件
- 05报告更改并询问是否开 PR
适用场景
- 01排查 Sphinx 文档构建问题
- 02修复可直接处理的文档警告
- 03在构建超时前检查输出
- 04准备文档修复的 PR
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/fix-sphix-docs确认已加载。
详细介绍
修复 Sphinx 文档构建中的错误和警告
此技能会反复运行 Sphinx 文档构建，并尝试修复容易处理的错误和警告。
步骤
- 运行 Sphinx 构建：
(source ./.venv/bin/activate && cd ./docs/ && make html)，但有个特别之处：想办法在 60 秒后中止，不要等待耗时过长的完整构建。 - 检查输出中的警告和错误，并尝试修复可以处理的问题。不要修改自动生成的 RST 文件。这些文件位于
_autosummary文件夹中，例如_autosummary_d2。用户会使用你不知道的特殊命令重新生成这些文件夹。 - 报告所做的更改。
- 询问是否可以创建 PR。
评论
支持 Markdown