Skip to content

Commit

Permalink
Updated the contributor translation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
flpm committed Sep 21, 2024
1 parent f95651e commit 6d0ae87
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions TRANSLATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ You can find a list of the two-letter Sphinx language option [here](https://www.

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.

You can do this by running the following command:
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):

```shell
$ nox -s update-translations
$ nox -s update-language -- LANG
```

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

## Building the Translated Documentation

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:
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)

```shell
nox -s build-translations
nox -s build-language -- LANG
```

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.).
Expand Down Expand Up @@ -251,7 +251,7 @@ You can follow these steps:
1. Build the translations of the guide with same parameters that will be used during the release:

```shell
nox -s build-translations-test
nox -s build-all-languages-test
```

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.
Expand Down Expand Up @@ -297,7 +297,7 @@ When you run the `sphinx-intl stat` command, you will see a list of `.po` files

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

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.
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.

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

Expand Down

0 comments on commit 6d0ae87

Please sign in to comment.