SuperAPI AI 工具集

fix-sphix-docs

编程与开发

查看项目

更新于 10-16 01:14

技能介绍

用途:该技能针对 Sphinx 文档构建过程,迭代运行构建并尝试修复容易处理的错误和警告,适用于需要清理文档构建告警的 Python 项目。

主要能力与使用方式:构建命令为 (source ./.venv/bin/activate && cd ./docs/ && make html),但需设置 60 秒后中止,避免等待完整构建。随后检查输出中的警告和错误,尝试修复可处理项。完成后报告所做的更改,并请求用户许可后再打开 PR。

限制:不要修改自动生成的 RST 文件,它们位于 _autosummary 类文件夹(如 _autosummary_d2)中;这些文件夹会由用户通过特殊命令重新生成,而该命令技能并不知晓。具体支持的语言、框架版本、修复范围与可用平台资料未提供。