2025-12-10 12:05:39 +08:00
|
|
|
|
## 🚀 Installation
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
|
|
|
|
|
|
uv venv myenv --python 3.12 --seed
|
|
|
|
|
|
source myenv/bin/activate
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤1:进入docs目录
|
2025-12-10 12:05:39 +08:00
|
|
|
|
cd docs
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤2:安装依赖(使用uv)
|
2025-12-10 12:05:39 +08:00
|
|
|
|
uv pip install -r requirements-docs.txt
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 安装 sphinx-autobuild(如果没在 requirements 文件里)
|
2025-12-10 12:05:39 +08:00
|
|
|
|
uv pip install sphinx-autobuild
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 从 docs 目录运行:
|
2025-12-10 12:05:39 +08:00
|
|
|
|
sphinx-autobuild ./source ./_build/html --port 8000
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤1:清理旧文件
|
2025-12-10 12:05:39 +08:00
|
|
|
|
make clean
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤2:构建HTML
|
2025-12-10 12:05:39 +08:00
|
|
|
|
make html
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤3:本地预览
|
2025-12-10 12:05:39 +08:00
|
|
|
|
python -m http.server -d _build/html/
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
浏览器访问:http://localhost:8000
|
2025-12-10 12:05:39 +08:00
|
|
|
|
|
|
|
|
|
|
🌍 Internationalization
|
2025-12-10 17:51:24 +08:00
|
|
|
|
国际化翻译流程(以中文为例)
|
2025-12-10 12:05:39 +08:00
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤1:提取可翻译文本(生成 .pot)
|
2025-12-10 12:05:39 +08:00
|
|
|
|
sphinx-build -b gettext source _build/gettext
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤2:生成/更新中文 .po 文件
|
2025-12-10 12:05:39 +08:00
|
|
|
|
sphinx-intl update -p _build/gettext -l zh_CN
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤3:人工翻译 .po 文件
|
|
|
|
|
|
# 用文本编辑器打开 source/locale/zh_CN/LC_MESSAGES/*.po
|
|
|
|
|
|
# 在 msgstr "" 里填入中文翻译
|
2025-12-10 12:05:39 +08:00
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤4:编译并构建中文文档
|
2025-12-10 12:05:39 +08:00
|
|
|
|
make intl
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
# 步骤5:查看效果
|
2025-12-10 12:05:39 +08:00
|
|
|
|
python -m http.server -d _build/html
|
|
|
|
|
|
|
|
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
浏览器访问:
|
2025-12-10 12:05:39 +08:00
|
|
|
|
|
2025-12-10 17:51:24 +08:00
|
|
|
|
英文版: http://localhost:8000
|
|
|
|
|
|
中文版: http://localhost:8000/zh-cn
|
2025-12-10 12:05:39 +08:00
|
|
|
|
|
|
|
|
|
|
```
|