PROS 文档翻译贡献指南

技术文档（软件）
翻译, 贡献指南
berberman

随着 V5 的发布，Purdue ACM SIGBots 更新了对应的软件文档。我们目前着手于 V5 文档的译制，v5-chinese 这个文件夹为 v5 的拷贝，所有中文翻译在此进行。

搭建文档编译环境

为了良好的翻译体验及更高的翻译效率，在本地构建出文档工程并预览是很有必要的。下面几步介绍了如何搭建起该文档工程的编译环境。

克隆工程

找一个地方，执行命令将仓库克隆到本地：

1
> git clone https://github.com/MechDancer/pros-docs

安装 PROS CLI

由于文档中使用 sphix-click 扩展将源码中的部分文档渲染进网页，因此需要先安装 PROS CLI。你可以在这里找到安装指南。

初始化子模块

在 sphinx_rtd_theme 和 sphinx-tabs 目录下运行：

1
2
> git submodule init
> git submodule update

初始化两个依赖的源码仓库。之后分别安装这两个子模块中的依赖：

1
2
3
4
5
> cd sphinx_rtd_theme
> pip install ./

> cd ../sphinx-tabs
> pip install ./

安装依赖

进入工程文件夹，使用 pip 安装其他依赖：

1
2
> cd pros-docs
> pip install -r requirements.txt

开始构建

运行命令：

1
> make chinese

若构建成功便会在工程文件夹中得到 ./build/v5-chinese/html 目录，其中包含网页文件。

注意：Windows 系统中可能不存在 make 命令，即无法执行 Makefile，此时可替换为 sphinx-build -M html v5-chinese/ build/v5-chinese/。

进行预览

我们推荐使用 Visual Studio Code 作为文本编辑工具，它具有支持 rst 的插件，可以进行实时预览。

安装扩展

在扩展商店中安装 reStructuredText 扩展。之后进行配置：

  • Restructuredtext: Conf Path 填写 ${workspaceFolder}/conf.py
  • Restructuredtext › Linter: Executable Path 填写 doc8 安装位置
  • Restructuredtext: Sphinx Build Path 填写 sphinx-build 安装位置

启用自动保存

我们推荐打开 Visual Studio Code 的失焦点自动保存，这样可以点击右侧预览窗口随时得到最新渲染的网页。

打开项目

在顶部栏中点击 文件 > 打开文件夹，选择 v5-chinese 目录即可。享受翻译带来的快乐：)