Amélioration de CONTRIBUTING.rst sur Poutils (#1682)

Mentionne le paquet Poutils qui permet d'installer tous les outils à la
fois, et ajoute une note sur l'installation du bon dictionnaire Hunspell
sous Debian.

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
Co-authored-by: Julien Palard <julien@palard.fr>
This commit is contained in:
Jean-Abou-Samra 2021-09-08 11:49:26 +02:00 committed by GitHub
parent 248e695415
commit 5439375dd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -726,38 +726,55 @@ avertissements.
Outils utiles pour la traduction Outils utiles pour la traduction
-------------------------------- --------------------------------
Potodo Poutils
~~~~~~ ~~~~~~~
| Permet de d'identifier les parties de la documention qu'il reste à traduire. `Poutils <https://pypi.org/project/poutils/>`_ est un paquet PyPI qui
| Installez-le à l'aide de *pip* (``pip install potodo``) dans un environnement regroupe un certain nombre d'outils liés à la traduction. Dans un
``python3.6`` ou plus. environnement disposant de Python 3.7 ou plus, installez-le avec ::
| `Lien vers le dépôt <https://github.com/AFPy/potodo>`__
python3 -m pip install poutils
Voici le détail des paquets qui nous intéressent dans Poutils :
Pospell
+++++++
Vérificateur d'orthographe fondé sur Hunspell. ``make spell`` exécute
Pospell. Pour l'utiliser, il vous faut installer Hunspell. Attention,
dans Debian notamment (et ses dérivés comme Ubuntu), il existe plusieurs
dictionnaires français qui diffèrent en raison de l'orthographe
réformée. Installez celui qui contient les deux orthographes avec ::
sudo apt install hunspell hunspell-fr-comprehensive
Potodo
++++++
Permet d'identifier les parties de la documentation qu'il reste à
traduire. ``make todo`` fait appel à Potodo.
Pogrep Pogrep
~~~~~~ ++++++
| Permet de rechercher dans la documentation des termes. Utile si on a un doute Permet de rechercher dans la documentation des termes. Utile si on a un doute
sur comment traduire un terme ou chercher la traduction d'un terme dans sur comment traduire un terme ou chercher la traduction d'un terme dans
d'autres fichiers. d'autres fichiers. Pour connaître les options disponibles, tapez ::
| Installez-le à l'aide de *pip* (``pip install pogrep``).
| `Lien vers le dépôt <https://github.com/AFPy/pogrep>`__
Padpo (beta) pogrep --help
~~~~~~~~~~~~
| Analyseur de code qui vérifie la grammaire et l'orthographe et la syntaxe
du fichier .po.
| Installez-le à l'aide de *pip* (``pip install padpo``) dans un environnement
``python3.7`` ou plus.
| `Lien vers le dépôt <https://github.com/AFPy/padpo>`__
Powrap Powrap
~~~~~~ ++++++
| Formateur de fichier .po. Formateur de fichier *.po*. C'est l'outil qui se cache derrière ``make
| Installez-le à l'aide de *pip* (``pip install powrap``). wrap``.
| `Lien vers le dépôt <https://github.com/AFPy/powrap>`__
Padpo (beta)
++++++++++++
Analyseur de code qui encapsule notamment `Grammalecte
<https://grammalecte.net>`_ et qui vérifie la grammaire, l'orthographe
et la syntaxe des fichiers *.po*.
Affichage des modifications par Git Affichage des modifications par Git