Skip to content

Commit 6d0ae87

Browse files
committed
Updated the contributor translation guide
1 parent f95651e commit 6d0ae87

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

TRANSLATING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ You can find a list of the two-letter Sphinx language option [here](https://www.
7272

7373
The translation files contain the original English text and a space for you to enter the translated text. Before starting to translate, you need to make sure the translation files are up to date with the latest changes to the guide.
7474

75-
You can do this by running the following command:
75+
You can do this by running the following command, replacing LANG by the language code you plan to work on (e.g., `es` for Spanish):
7676

7777
```shell
78-
$ nox -s update-translations
78+
$ nox -s update-language -- LANG
7979
```
8080

8181
This command will create the translation files if they don't exist yet, or update them with the latest changes if they already exist.
@@ -220,10 +220,10 @@ When working on a translation, you **should not** modify the original English te
220220

221221
## Building the Translated Documentation
222222

223-
Once you finished translating or when you want to check the translation in context, you can build the guide locally on your computer, using the following command:
223+
Once you finished translating or when you want to check the translation in context, you can build the guide locally on your computer, using the following command, replacing LANG by the proper language code (e.g., `es` for Spanish)
224224

225225
```shell
226-
nox -s build-translations
226+
nox -s build-language -- LANG
227227
```
228228

229229
This command will build all the translated versions of the guide defined in the `LANGUAGES` list in `noxfile.py`. These translations will be stored in the `_build/html`, in folders named after the language code (e.g., `es`, `fr`, etc.).
@@ -251,7 +251,7 @@ You can follow these steps:
251251
1. Build the translations of the guide with same parameters that will be used during the release:
252252

253253
```shell
254-
nox -s build-translations-test
254+
nox -s build-all-languages-test
255255
```
256256

257257
2. Make sure there are no warnings or errors in the output. If there are, you will need to fix them before submitting the PR.
@@ -297,7 +297,7 @@ When you run the `sphinx-intl stat` command, you will see a list of `.po` files
297297

298298
### What happens when a string has changed in the original English text?
299299

300-
If a string has changed in the original English version, it will be marked as `fuzzy` in the translation file the next time it is updated (`nox -s update-translations`). Contributors working on the translation can then review the fuzzy entries and make the necessary changes to ensure it is accurate, before removing the `fuzzy` tag.
300+
If a string has changed in the original English version, it will be marked as `fuzzy` in the translation file the next time it is updated (`update-language`, `update-all-languages`, or `update-all-release-languages`). Contributors working on the translation can then review the fuzzy entries and make the necessary changes to ensure it is accurate, before removing the `fuzzy` tag.
301301

302302
### How do I handle links in the translated text?
303303

0 commit comments

Comments
 (0)