Skip to content

Commit e9ca2ef

Browse files
committed
deploy: cdbdf85
1 parent 0c5ce3b commit e9ca2ef

File tree

5 files changed

+17
-24
lines changed

5 files changed

+17
-24
lines changed

.doctrees/TRANSLATING.doctree

1.7 KB
Binary file not shown.

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

TRANSLATING.html

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,8 @@ <h2>Starting a New Language Translation<a class="headerlink" href="#starting-a-n
543543
<section id="preparing-the-translation-files">
544544
<h2>Preparing the Translation Files<a class="headerlink" href="#preparing-the-translation-files" title="Link to this heading">#</a></h2>
545545
<p>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.</p>
546-
<p>You can do this by running the following command:</p>
547-
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>nox<span class="w"> </span>-s<span class="w"> </span>update-translations
546+
<p>You can do this by running the following command, replacing LANG by the language code you plan to work on (e.g., <code class="docutils literal notranslate"><span class="pre">es</span></code> for Spanish):</p>
547+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>nox<span class="w"> </span>-s<span class="w"> </span>update-language<span class="w"> </span>--<span class="w"> </span>LANG
548548
</pre></div>
549549
</div>
550550
<p>This command will create the translation files if they don’t exist yet, or update them with the latest changes if they already exist.</p>
@@ -661,8 +661,8 @@ <h2>Editing the Translation Files<a class="headerlink" href="#editing-the-transl
661661
</section>
662662
<section id="building-the-translated-documentation">
663663
<h2>Building the Translated Documentation<a class="headerlink" href="#building-the-translated-documentation" title="Link to this heading">#</a></h2>
664-
<p>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:</p>
665-
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-s<span class="w"> </span>build-translations
664+
<p>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., <code class="docutils literal notranslate"><span class="pre">es</span></code> for Spanish)</p>
665+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-s<span class="w"> </span>build-language<span class="w"> </span>--<span class="w"> </span>LANG
666666
</pre></div>
667667
</div>
668668
<p>This command will build all the translated versions of the guide defined in the <code class="docutils literal notranslate"><span class="pre">LANGUAGES</span></code> list in <code class="docutils literal notranslate"><span class="pre">noxfile.py</span></code>. These translations will be stored in the <code class="docutils literal notranslate"><span class="pre">_build/html</span></code>, in folders named after the language code (e.g., <code class="docutils literal notranslate"><span class="pre">es</span></code>, <code class="docutils literal notranslate"><span class="pre">fr</span></code>, etc.).</p>
@@ -682,7 +682,7 @@ <h2>Submitting a PR for Your Contribution<a class="headerlink" href="#submitting
682682
<ol class="arabic simple">
683683
<li><p>Build the translations of the guide with same parameters that will be used during the release:</p></li>
684684
</ol>
685-
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-s<span class="w"> </span>build-translations-test
685+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-s<span class="w"> </span>build-all-languages-test
686686
</pre></div>
687687
</div>
688688
<ol class="arabic simple" start="2">
@@ -720,7 +720,7 @@ <h3>How do I know which strings need to be translated?<a class="headerlink" href
720720
</section>
721721
<section id="what-happens-when-a-string-has-changed-in-the-original-english-text">
722722
<h3>What happens when a string has changed in the original English text?<a class="headerlink" href="#what-happens-when-a-string-has-changed-in-the-original-english-text" title="Link to this heading">#</a></h3>
723-
<p>If a string has changed in the original English version, it will be marked as <code class="docutils literal notranslate"><span class="pre">fuzzy</span></code> in the translation file the next time it is updated (<code class="docutils literal notranslate"><span class="pre">nox</span> <span class="pre">-s</span> <span class="pre">update-translations</span></code>). Contributors working on the translation can then review the fuzzy entries and make the necessary changes to ensure it is accurate, before removing the <code class="docutils literal notranslate"><span class="pre">fuzzy</span></code> tag.</p>
723+
<p>If a string has changed in the original English version, it will be marked as <code class="docutils literal notranslate"><span class="pre">fuzzy</span></code> in the translation file the next time it is updated (<code class="docutils literal notranslate"><span class="pre">update-language</span></code>, <code class="docutils literal notranslate"><span class="pre">update-all-languages</span></code>, or <code class="docutils literal notranslate"><span class="pre">update-all-release-languages</span></code>). Contributors working on the translation can then review the fuzzy entries and make the necessary changes to ensure it is accurate, before removing the <code class="docutils literal notranslate"><span class="pre">fuzzy</span></code> tag.</p>
724724
</section>
725725
<section id="how-do-i-handle-links-in-the-translated-text">
726726
<h3>How do I handle links in the translated text?<a class="headerlink" href="#how-do-i-handle-links-in-the-translated-text" title="Link to this heading">#</a></h3>
@@ -759,11 +759,8 @@ <h3>How do I know when a translation is ready to be released?<a class="headerlin
759759
</section>
760760
<section id="how-can-i-get-help-with-my-translation">
761761
<h3>How can I get help with my translation?<a class="headerlink" href="#how-can-i-get-help-with-my-translation" title="Link to this heading">#</a></h3>
762-
<p>If you have any questions or need help with your translation, you can create an issue in the repository.</p>
763-
<p>TODO: Maybe <a class="reference external" href="https://pyopensci.discourse.group/">Discourse</a> could be used as a way for contributors to ask for help with translations or the translation workflow?</p>
764-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>
765-
</pre></div>
766-
</div>
762+
<p>If you have any questions or need help with your translation, you can create an <a class="reference external" href="https://github.com/pyOpenSci/python-package-guide/issues">issue</a> in the <a class="reference external" href="https://github.com/pyOpenSci/python-package-guide">Packaging Guide repository</a></p>
763+
<p>You can also ask in the PyOpenSci Discord server (<a class="reference external" href="https://discord.gg/CvSMp4zcqX">click here</a> to join), you will find a general channel for questions related to our workflow, processes, and tools (translation-general) and channels for each of the languages we are working on (spanish-translation, japanese-translation, etc).</p>
767764
</section>
768765
</section>
769766
</section>

_sources/TRANSLATING.md.txt

Lines changed: 8 additions & 12 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

@@ -340,10 +340,6 @@ TODO: There are many approaches here, some projects release a translation as soo
340340

341341
### How can I get help with my translation?
342342

343-
If you have any questions or need help with your translation, you can create an issue in the repository.
343+
If you have any questions or need help with your translation, you can create an [issue](https://github.com/pyOpenSci/python-package-guide/issues) in the [Packaging Guide repository](https://github.com/pyOpenSci/python-package-guide)
344344

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?
346-
347-
```
348-
349-
```
345+
You can also ask in the PyOpenSci Discord server ([click here](https://discord.gg/CvSMp4zcqX) to join), you will find a general channel for questions related to our workflow, processes, and tools (translation-general) and channels for each of the languages we are working on (spanish-translation, japanese-translation, etc).

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)