CONTRIBUTING.rst: options longues dans les blocs de code (#1373)

* Add missing `code-block`

Add missing `code-block`

Homogenize the number of new lines after code blocks to 2 lines.

* fix RST syntax

* options longues pour le bloc de code pomerge

* les autres

Co-authored-by: Vincent Poulailleau <vpoulailleau@gmail.com>
This commit is contained in:
Mathieu Dupuy 2020-08-11 09:41:45 +02:00 committed by GitHub
parent 12a5a372b3
commit b52b0a56d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -81,7 +81,7 @@ Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3
.. code-block:: bash .. code-block:: bash
git checkout -b library-sys upstream/3.9 git checkout --branch library-sys upstream/3.9
Vous pouvez maintenant travailler sur le fichier. Vous pouvez maintenant travailler sur le fichier.
@ -113,18 +113,21 @@ en anglais.
make spell make spell
Vous pouvez aussi réindenter les fichiers avec : Vous pouvez aussi réindenter les fichiers avec :
.. code-block:: bash .. code-block:: bash
make wrap make wrap
Et pour faire les deux à la fois, lancez : Et pour faire les deux à la fois, lancez :
.. code-block:: bash .. code-block:: bash
make verifs make verifs
Une fois la traduction finie, il faut compiler la documentation, c'est-à-dire générer les fichiers HTML 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 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. compilation ne devrait pas échouer.
@ -133,6 +136,7 @@ compilation ne devrait pas échouer.
make make
Vérifiez alors le rendu de la traduction « en vrai ». Lancez un serveur de Vérifiez alors le rendu de la traduction « en vrai ». Lancez un serveur de
documentation local : documentation local :
@ -140,6 +144,7 @@ documentation local :
make serve make serve
La documentation est publiée l'adresse `<http://localhost:8000/library/sys.html>`_ La documentation est publiée l'adresse `<http://localhost:8000/library/sys.html>`_
(ou tout autre port indiqué par la sortie de la commande précédente). Vous pouvez (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. recommencer les étapes de cette section autant de fois que nécessaire.
@ -167,7 +172,8 @@ attendant d'être propagées dans le dépôt local.
.. code-block:: bash .. code-block:: bash
git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :) git commit --message "Traduction de library/sys.po" # Ou un autre message plus inspiré :)
Poussez ensuite vos modifications sur votre *fork* Github avec ``git push``. 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 Le ``-u`` n'est utile qu'une fois pour que votre client git se souvienne que cette
@ -176,7 +182,8 @@ branche est liée à votre *fork* Github (et donc que vos futurs ``git pull`` et
.. code-block:: bash .. code-block:: bash
git push -u origin git push --set-upstream origin
La commande précédente vous affiche un lien pour ouvrir une pull request sur 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 Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls
@ -199,7 +206,7 @@ sur une autre branche) :
# sur l'interface web. # sur l'interface web.
# Réglez les problèmes, puis commitez à nouveau : # Réglez les problèmes, puis commitez à nouveau :
git commit -a -m "prise en compte des remarques" git commit --all --message "prise en compte des remarques"
git push git push
@ -321,6 +328,7 @@ utilisés, en prenant garde d'être cohérent. Vous pouvez ainsi traduire :
result = thread.join(timeout=...) result = thread.join(timeout=...)
... ...
en en
.. code-block:: python .. code-block:: python
@ -329,6 +337,7 @@ en
resultat = thread.join(timeout=...) resultat = thread.join(timeout=...)
... ...
mais pas en mais pas en
.. code-block:: python .. code-block:: python
@ -337,6 +346,7 @@ mais pas en
resultat = fildexécution.attendre(délai=...) resultat = fildexécution.attendre(délai=...)
... ...
Liens hypertextes Liens hypertextes
+++++++++++++++++ +++++++++++++++++
@ -538,6 +548,7 @@ Ensuite, dans votre fichier '~/.xsession', ajoutez :
# Gestion des touches clavier # Gestion des touches clavier
xmodmap $HOME/.Xmodmap xmodmap $HOME/.Xmodmap
Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller
modifier dans les « Paramètres » → « Clavier » → « Disposition » → modifier dans les « Paramètres » → « Clavier » → « Disposition » →
« Touche composée ». Pour finir, redémarrez votre session. « 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:406
+#: ../Doc/library/signal.rst:408 +#: ../Doc/library/signal.rst:408
Pour dire à git que ce ne sont pas des informations utiles, vous pouvez faire 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 ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre
``PATH``. ``PATH``.
@ -707,12 +719,14 @@ de ``python-docs-fr`` et certaines s'attendent à trouver un clone de CPython
├── python-docs-fr/ ├── python-docs-fr/
└── cpython/ └── cpython/
Pour cloner CPython, vous pouvez utiliser : Pour cloner CPython, vous pouvez utiliser :
.. code-block:: bash .. code-block:: bash
git clone --depth 1 --no-single-branch https://github.com/python/cpython.git 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 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. documentation) mais récupère néanmoins toutes les branches.
@ -737,25 +751,28 @@ Dans certains cas on a besoin de bouger des traductions d'une branche
- d'une nouvelle branche vers des anciennes branches : pour propager - d'une nouvelle branche vers des anciennes branches : pour propager
de temps en temps le travail sur d'anciennes releases (*back porting*). de temps en temps le travail sur d'anciennes releases (*back porting*).
Pour forward-porter un ou plusieurs commits, il vaut mieux utiliser `git 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 cherry-pick -x LE_SHA``, ça garde l'auteur, le sha1 d'origine, et
toutes les modifications. 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 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
git fetch git fetch
git checkout 3.8 git checkout 3.8
git reset --hard upstream/3.8 git reset --hard upstream/3.8
pomerge --from-files *.po */*.po pomerge --from-files *.po */*.po
git checkout -b back-porting upstream/3.7 git checkout --branch back-porting upstream/3.7
pomerge --no-overwrite --to-files *.po */*.po pomerge --no-overwrite --to-files *.po */*.po
powrap -m powrap --modified
git add --patch git add --patch
git commit --message="Backporting from 3.8" git commit --message="Backporting from 3.8"
git push --set-upstream origin HEAD git push --set-upstream origin HEAD
Notes : Notes :
- j'utilise ``git fetch`` au début pour avoir upstream/3.7 et - j'utilise ``git fetch`` au début pour avoir upstream/3.7 et
@ -796,20 +813,21 @@ Propagez d'abord les traductions connues localement :
.. code-block:: bash .. code-block:: bash
pomerge --no-overwrite --from-files **/*.po --to-files **/*.po pomerge --no-overwrite --from-files **/*.po --to-files **/*.po
powrap --modified powrap --modified
git commit -m "Propagating known translations." git commit --message "Propagating known translations."
Ensuite récupérez les changements depuis Transifex : Ensuite récupérez les changements depuis Transifex :
.. code-block:: bash .. code-block:: bash
tx pull -f --parallel tx pull -f --parallel
pomerge --from-files **/*.po pomerge --from-files **/*.po
git checkout -- . git checkout -- .
pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po pomerge --no-overwrite --mark-as-fuzzy --to-files **/*.po
powrap --modified powrap --modified
git add -p git add -p
git commit -m "tx pull" git commit -m "tx pull"
tx push -t -f --no-interactive --parallel tx push -t -f --no-interactive --parallel