You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Translated strings are strings that have been translated into the target language.
133
135
- Fuzzy strings are strings that have been translated but need to be reviewed because the original English string in the guide changed.
134
136
- Untranslated strings are strings that have not been translated yet.
@@ -236,11 +238,10 @@ nox -s docs-live-lang -- es
236
238
237
239
Note the `--` before the language code, it indicates that the following arguments should be passed into the nox session and not be interpreted directly by nox. If you forget the `--`, nox will look instead for a session named 'es' and complain that it does not exist.
238
240
239
-
This command will use `sphinx-autobuild` to launch a local web server where you can access the translated version of the guide. You can open the guide in your browser by navigating to [http://localhost:8000](http://localhost:8000).
241
+
This command will use `sphinx-autobuild` to launch a local web server where you can access the translated version of the guide. You can open the guide in your browser by navigating to `http://localhost:8000`.
240
242
241
243
This is a great way to see how the translated version of the guide looks as you make changes to the translation files.
242
244
243
-
244
245
## Submitting a PR for Your Contribution
245
246
246
247
Once you are finished translating and before you submit a pull request (PR) for your translation, you need to make sure that the translated version of the guide builds without any errors or warning and looks correctly in the browser.
@@ -288,8 +289,6 @@ When the guide is built for release in CI, Sphinx will also generate the transla
288
289
289
290
Translations are released in the same way as the English version of the guide, and the translated versions will be available in folders named after the language code. For example, the Spanish translation will be available in [https://www.pyopensci.org/python-package-guide/es/](https://www.pyopensci.org/python-package-guide/es/).
290
291
291
-
292
-
293
292
## Frequently Asked Questions (FAQ)
294
293
295
294
### How do I know which strings need to be translated?
@@ -329,12 +328,10 @@ You should not translate images in the guide. Producing translated versions of i
329
328
330
329
In some special cases, an image might be critical to the understanding of the content. In those cases, the translations will be handled by the maintainers and editors outside this workflow.
331
330
332
-
333
331
### I am interested in translating the guide into a language that is not listed. How can I get started?
334
332
335
333
If you want to start a new translation of the guide into a language that is not listed, you should [create an issue](https://github.com/pyOpenSci/python-package-guide/issues) in the repository to let the maintainers know that you intend to work on it. This will help avoid duplication of effort and ensure that the maintainers are ready to review your contribution when you are done.
336
334
337
-
338
335
### How do I know when a translation is ready to be released?
339
336
340
337
When a translation is ready to be included in the next release of the guide, the maintainers will add the language code to the `RELEASE_LANGUAGES` list in the `noxfile.py` configuration file. This will trigger the build of the translation during the release process, and the translated version of the guide will be available on the pyOpenSci website.
@@ -348,3 +345,5 @@ If you have any questions or need help with your translation, you can create an
348
345
TODO: Maybe [Discourse](https://pyopensci.discourse.group/) could be used as a way for contributors to ask for help with translations or the translation workflow?
0 commit comments