From 7b4c3b5f85fb2c9c2a33ab5284faa1d2f28f964c Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Mon, 3 Aug 2020 11:46:03 +0200 Subject: [PATCH 1/2] Add missing `code-block` Add missing `code-block` Homogenize the number of new lines after code blocks to 2 lines. --- CONTRIBUTING.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0cbd54bc3..115834664 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -113,18 +113,21 @@ en anglais. make spell + Vous pouvez aussi réindenter les fichiers avec : .. code-block:: bash make wrap + Et pour faire les deux à la fois, lancez : .. code-block:: bash make verifs + Une fois la traduction finie, il faut compiler la documentation, c'est-à-dire générer les fichiers HTML affichés par le site, pour les relire. Si la commande précédente s'est exécutée sans erreur, la compilation ne devrait pas échouer. @@ -133,6 +136,7 @@ compilation ne devrait pas échouer. make + Vérifiez alors le rendu de la traduction « en vrai ». Lancez un serveur de documentation local : @@ -140,6 +144,7 @@ documentation local : make serve + La documentation est publiée l'adresse ``_ (ou tout autre port indiqué par la sortie de la commande précédente). Vous pouvez recommencer les étapes de cette section autant de fois que nécessaire. @@ -169,6 +174,7 @@ attendant d'être propagées dans le dépôt local. git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :) + Poussez ensuite vos modifications sur votre *fork* Github avec ``git push``. Le ``-u`` n'est utile qu'une fois pour que votre client git se souvienne que cette branche est liée à votre *fork* Github (et donc que vos futurs ``git pull`` et @@ -178,6 +184,7 @@ branche est liée à votre *fork* Github (et donc que vos futurs ``git pull`` et git push -u origin + La commande précédente vous affiche un lien pour ouvrir une pull request sur Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls et un joli bouton « Compare & pull request » devrait apparaître au bout de @@ -321,6 +328,7 @@ utilisés, en prenant garde d'être cohérent. Vous pouvez ainsi traduire : result = thread.join(timeout=...) ... + en .. code-block:: python @@ -329,6 +337,7 @@ en resultat = thread.join(timeout=...) ... + mais pas en .. code-block:: python @@ -337,6 +346,7 @@ mais pas en resultat = fildexécution.attendre(délai=...) ... + Liens hypertextes +++++++++++++++++ @@ -538,6 +548,7 @@ Ensuite, dans votre fichier '~/.xsession', ajoutez : # Gestion des touches clavier xmodmap $HOME/.Xmodmap + Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller modifier dans les « Paramètres » → « Clavier » → « Disposition » → « Touche composée ». Pour finir, redémarrez votre session. @@ -674,6 +685,7 @@ de ligne, comme : -#: ../Doc/library/signal.rst:406 +#: ../Doc/library/signal.rst:408 + Pour dire à git que ce ne sont pas des informations utiles, vous pouvez faire ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre ``PATH``. @@ -707,12 +719,14 @@ de ``python-docs-fr`` et certaines s'attendent à trouver un clone de CPython ├── python-docs-fr/ └── cpython/ + Pour cloner CPython, vous pouvez utiliser : .. code-block:: bash git clone --depth 1 --no-single-branch https://github.com/python/cpython.git + Ceci évite de télécharger tout l'historique (inutile pour générer la documentation) mais récupère néanmoins toutes les branches. @@ -745,6 +759,8 @@ Pour backporter "en gros" on utilise ``pomerge``\  : on le fait lire sur une branche, puis écrire sur une autre, par exemple pour copier de la 3.8 à la 3.7 :: +.. code-block:: bash + git fetch git checkout 3.8 git reset --hard upstream/3.8 @@ -756,6 +772,7 @@ la 3.8 à la 3.7 :: git commit --message="Backporting from 3.8" git push --set-upstream origin HEAD + Notes : - j'utilise ``git fetch`` au début pour avoir upstream/3.7 et @@ -813,3 +830,4 @@ Ensuite récupérez les changements depuis Transifex : git add -p git commit -m "tx pull" tx push -t -f --no-interactive --parallel + From 84af6539539d34922e905a5d8c73708d1b481b75 Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Sun, 9 Aug 2020 13:41:24 +0200 Subject: [PATCH 2/2] fix RST syntax --- CONTRIBUTING.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 115834664..24ddf039a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -751,13 +751,13 @@ Dans certains cas on a besoin de bouger des traductions d'une branche - d'une nouvelle branche vers des anciennes branches : pour propager de temps en temps le travail sur d'anciennes releases (*back porting*). -Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser `git -cherry-pick -x LE_SHA`, ça garde l'auteur, le sha1 d'origine, et +Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser ``git +cherry-pick -x LE_SHA``, ça garde l'auteur, le sha1 d'origine, et toutes les modifications. -Pour backporter "en gros" on utilise ``pomerge``\  : on le fait lire +Pour backporter « en gros » on utilise ``pomerge``\  : on le fait lire sur une branche, puis écrire sur une autre, par exemple pour copier de -la 3.8 à la 3.7 :: +la 3.8 à la 3.7 : .. code-block:: bash @@ -813,21 +813,21 @@ Propagez d'abord les traductions connues localement : .. code-block:: bash - pomerge --no-overwrite --from-files **/*.po --to-files **/*.po - powrap --modified - git commit -m "Propagating known translations." + pomerge --no-overwrite --from-files **/*.po --to-files **/*.po + powrap --modified + git commit -m "Propagating known translations." Ensuite récupérez les changements depuis Transifex : .. code-block:: bash - tx pull -f --parallel - pomerge --from-files **/*.po - git checkout -- . - pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po - powrap --modified - git add -p - git commit -m "tx pull" - tx push -t -f --no-interactive --parallel + tx pull -f --parallel + pomerge --from-files **/*.po + git checkout -- . + pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po + powrap --modified + git add -p + git commit -m "tx pull" + tx push -t -f --no-interactive --parallel