更多关于我们的翻译流程如何运作#

备注

感谢 frc-docs-translation 为我们提供了这么好的资源供我们参考。而我们所有的翻译工作都是自动的!

简介#

这个伟大的工作是由Github Action与几个自动脚本完成的。

如何将这个工作流程应用于你自己的项目#

  1. 复制并粘贴 scripts/ 、 .github/workflow/ 和 requirements.txt 文件夹到你项目的根目录。

  2. 改变 scripts/lock-translations.py 、 scripts/update.sh 、 .github/workflow/publish_main.yml 、 .github/workflow/update-translations.yml 中的相应部分。

在 scripts/lock-translations.py 中#

  1. 更改 PROJECT_FILTER_PARAM 和 PROJECT_DELETE_PARAM 。

PROJECT_FILTER_PARAM = {"filter[project]": "o:Your organization on Transifex:p:Your project name"}
PROJECT_DELETE_PARAM = {"o:Your organization on Transifex:p:Your project name:r:"}

备注

你在Transifex的组织 可以在你的Transifex项目的URL中找到。并记住所有的字母都是小写的。

  1. 将引号中的内容改为你的项目名称。

section = section.split("6940swerve-docs.", 1)

在 scripts/update.sh 中#

  1. 将 LANG_TO_PULL 和 LANG_MAP 改为你想要翻译的语言。

#LANG_TO_PULL=${1:-'fr_CA,es_MX,zh_CN,tr_TR,he_IL,pt'}
LANG_TO_PULL=${1:-'zh_CN'}
#LANG_MAP='es_MX: es, fr_CA: fr, he_IL: he, tr_TR: tr'
LANG_MAP='zh_CN: zh_CN'

  1. 将 MAINPROJECT 名称改为你的项目名称。

section = section.split("6940swerve-docs.", 1)

  1. 将下面的最后两个参数改为你的 …/source/ 目录（你的 conf.py 所在的位置）和你想放 .POT 文件的位置。

# Create POT Files
sphinx-build -T -b gettext docs/source docs/pot

  1. 把下图中的两个 docs/pot 和 docs/locales 改为你的 .POT 文件所在的目录和你的翻译文件（也可以称为 .PO 文件）所在的目录。

sphinx-intl update-txconfig-resources -p docs/pot -d docs/locales --transifex-project-name $MAINPROJECT

在 .github/workflow/publish_main.yml 中#

你知道哪些部分应该改变，我在这里就不多说了。

在 .github/workflow/update-translations.yml 中#

  1. 将 github.repository 改为你自己的repo。

  2. 如果你没有一个子模块，只需注解相关的三行代码。

  3. 在你的版本库设置中创建一个repository secret，命名为 TX_TOKEN ，并在secret中粘贴你的Transifex api令牌。

现在你可以测试你的工作流程是否运行良好！。