Skip to content

Commit 0d8c24f

Browse files
committed
Merging README from master.
So we're getting a full while landing on github ( now that 3.7 is the default github branch).
1 parent 6f1e937 commit 0d8c24f

File tree

1 file changed

+221
-6
lines changed

1 file changed

+221
-6
lines changed

README.rst

Lines changed: 221 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
French Translation of the Python Documentation
22
==============================================
33

4-
**Translated: 29%**
5-
6-
See the `README.rst file on master
7-
<https://github.com/python/python-docs-fr/blob/master/README.rst>`_
8-
for more informations.
9-
4+
**Translated: 28%**
105

116
Documentation Contribution Agreement
127
------------------------------------
@@ -29,3 +24,223 @@ Python community is welcomed and appreciated.
2924

3025
You signify acceptance of this agreement by submitting your work to
3126
the PSF for inclusion in the documentation.
27+
28+
29+
Contributing to the Translation
30+
-------------------------------
31+
32+
How to Contribute
33+
~~~~~~~~~~~~~~~~~
34+
35+
You can either contribute on `transifex/python-doc/public
36+
<https://www.transifex.com/python-doc/public/>`_, or by simply openning an
37+
issue on this repository, or by editing the ``po`` files.
38+
39+
To modify those files you first have to fork this project and follow
40+
github instructions to clone it.
41+
42+
Next, to edit the files, you can use an editor of your choice, there's many:
43+
44+
- Highly recommended: `poedit <http://www.poedit.net/>`_
45+
- gted
46+
- gtranslator
47+
- lokalize
48+
- betterpoeditor
49+
- vim or emacs with an appropriate mode
50+
- Vé on Android
51+
- Probably many others
52+
53+
Before commiting, you should use `grammalecte
54+
<https://www.dicollecte.org/>`_ to check for your translations.
55+
56+
Finally, once your contribution is done, do a ``pull request`` so we
57+
can review and merge it.
58+
59+
Please write your issues and pull requests in english for consistency
60+
with the python github organization and because non-french people may
61+
receive github notifications about our activity.
62+
63+
64+
What to translate
65+
~~~~~~~~~~~~~~~~~
66+
67+
You can start with easy tasks like reviewing fuzzy entries to help
68+
keeping the documentation up to date (find them using ``make fuzzy``).
69+
70+
You can also proofread already translated entries, and finally
71+
translate untranslated ones (find them using ``make todo``)..
72+
73+
- Do not translate content of ``:ref:...`` and ``:term:...``
74+
- Put english words, if you have to use them, in *italics* (surrounded
75+
by stars).
76+
- ``::`` at the end of some paragraphs have to be translated to `` :
77+
::`` in French to place the space before the column.
78+
- If you translate a link title, please translate the link too
79+
(typically if it's Wikipedia and the article has a translation). If
80+
no translation of the target exists, do not translate the
81+
title.
82+
83+
84+
Where to get help
85+
~~~~~~~~~~~~~~~~~
86+
87+
The coordinator for this translation is `mdk <https://mdk.fr/>`_.
88+
89+
Feel free to ask your questions on ``#python-fr`` on `freenode
90+
<https://webchat.freenode.net/>`_.
91+
92+
93+
Translation Resources
94+
---------------------
95+
96+
- `Le Grand Dictionnaire Terminologique <http://gdt.oqlf.gouv.qc.ca/>`_
97+
- IRC channel `#python-fr <http://irc.lc/freenode/python-fr>`_ on freenode.
98+
- The `liste traductions <http://lists.afpy.org/mailman/listinfo/traductions>`_.
99+
- The `doc-sig mailing list
100+
<https://mail.python.org/mailman/listinfo/doc-sig>`_.
101+
- `Glossaire traduc.org <http://glossaire.traduc.org>`_
102+
- `Glossaires et Dictionnaires of traduc.org
103+
<https://traduc.org/Glossaires_et_dictionnaires>`_
104+
- `glossary.po <https://docs.python.org/fr/3/glossary.html>`_, as it's
105+
already translated.
106+
- `deepl.com/translator <https://www.deepl.com>`_
107+
108+
109+
Glossary
110+
--------
111+
112+
For consistency in our translations, here are some propositions and
113+
reminders for frequent terms you'll have to translate, don't hesitate
114+
to open an issue if you disagree.
115+
116+
========================== ===========================================
117+
Term Proposed Translation
118+
========================== ===========================================
119+
-like -compatible
120+
abstract data type type abstrait
121+
argument argument (Don't mix with parameter)
122+
backslash antislash, *backslash*
123+
bound lier
124+
bug bogue, *bug*
125+
built-in native
126+
call stack pile d'appels
127+
debugging débogage
128+
double quote guillemet
129+
e.g. e.g. (pour *exempli gratia*)
130+
garbage collector ramasse-miettes
131+
identifier identifiant
132+
immutable immuable
133+
interpreter interpréteur
134+
library bibliothèque
135+
list comprehension liste en compréhension
136+
little-endian, big-endian `petit-boutiste, gros-boutiste
137+
<https://fr.wikipedia.org/wiki/Endianness>`_
138+
mutable muable
139+
namespace *namespace*, espace de noms
140+
parameter paramètre
141+
prompt invite
142+
raise lever
143+
regular expression expression rationnelle, expression régulière
144+
return renvoie, donne (On évite
145+
"retourne" qui pourrait porter à confusion.
146+
simple quote guillemet simple, apostrophe (apostrophe
147+
is to glue, guillemet is to surround)
148+
socket *socket*
149+
statement instruction
150+
thread fil d'exécution
151+
underscore tiret bas, *underscore*
152+
========================== ===========================================
153+
154+
155+
Project History
156+
---------------
157+
158+
This project was started `around 2012
159+
<https://github.com/AFPy/python_doc_fr/commit/b77bdff59036b6b5a4804d5f519ce3ea341e027c>`_
160+
by `afpy <https://www.afpy.org/>`_ members, in 2017 this project
161+
became the official french Python documentation translation thanks to
162+
`PEP 545 <https://www.python.org/dev/peps/pep-0545/>`_.
163+
164+
165+
Simplify git diffs
166+
------------------
167+
168+
Git diffs are often crowded with useless line number changes, like:
169+
170+
-#: ../Doc/library/signal.rst:406
171+
+#: ../Doc/library/signal.rst:408
172+
173+
To tell git they are not usefull information, you can do the following
174+
after ensuring ``~/.local/bin/`` is in your ``PATH``.
175+
176+
cat <<EOF > ~/.local/bin/podiff
177+
#!/bin/sh
178+
grep -v '^#:' "\$1"
179+
EOF
180+
181+
chmod a+x ~/.local/bin/podiff
182+
183+
git config diff.podiff.textconv podiff
184+
185+
186+
Maintenance
187+
-----------
188+
189+
All those snippets are to run from the root of a ``python-docs-fr``
190+
clone, and some expect to find an up-to-date CPython clone near to it,
191+
like::
192+
193+
~/
194+
├── python-docs-fr/
195+
└── cpython/
196+
197+
To clone CPython you may use::
198+
199+
git clone --depth 1 --no-single-branch https://github.com/python/cpython.git
200+
201+
This avoids to download the whole history (not usefull to build
202+
documentation) but still fetches all branches.
203+
204+
205+
Merge pot files from CPython
206+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
207+
208+
.. code-block:: bash
209+
210+
make merge
211+
212+
213+
Find fuzzy strings
214+
~~~~~~~~~~~~~~~~~~
215+
216+
.. code-block:: bash
217+
218+
make fuzzy
219+
220+
221+
Run a test build locally
222+
~~~~~~~~~~~~~~~~~~~~~~~~
223+
224+
.. code-block:: bash
225+
226+
make
227+
228+
229+
Synchronize translation with Transifex
230+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231+
232+
You'll need the ``transifex-client`` and ``poindent``
233+
from Pypi.
234+
235+
You'll need to configure ``tx`` via ``tx init`` if not already done.
236+
237+
You should work on a separate ``transifex`` branch.
238+
239+
.. code-block:: bash
240+
241+
tx pull
242+
poindent --modified
243+
git commit -m "tx pull"
244+
git checkout 3.6
245+
git merge transifex -Xours
246+
tx push -t

0 commit comments

Comments
 (0)