fix-sphix-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

This skill iterates over Sphinx docs build and attempt to fix easily addressable errors and warnings.

本Skill会遍历Sphinx文档构建过程，尝试修复易于解决的错误和警告。

Run Sphinx build:
```
(source ./.venv/bin/activate && cd ./docs/ && make html)
```
, but with a twist: figure out how to abort after 60 second do not try to wait for the full build takes too long.
Check the output warnings and errors you could attempt to fix. DON'T TOUCH AUTO GENERATED RST FILES. These are in
```
_autosummary
```
folders like
```
_autosummary_d2
```
. These folders will be recreated by user with a special command you do not know.
Report made changes
Ask a permission to open a PR

运行Sphinx构建：
```
(source ./.venv/bin/activate && cd ./docs/ && make html)
```
，但有一点需要注意：要想办法在60秒后终止构建，不要等待完整构建完成，因为耗时太长。
检查输出中的警告和错误，尝试修复这些问题。请勿修改自动生成的RST文件，这些文件位于
```
_autosummary
```
文件夹（如
```
_autosummary_d2
```
）中。用户会通过一个你不知道的特殊命令重新生成这些文件夹。
报告已做出的修改
请求许可以创建PR