Skip to content

Latest commit

 

History

History
386 lines (278 loc) · 13 KB

README.rst

File metadata and controls

386 lines (278 loc) · 13 KB
Raw

French Translation of the Python Documentation

https://travis-ci.org/python/python-docs-fr.svg?branch=3.7

Translated: 39%

Documentation Contribution Agreement

NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is maintained using a global network of volunteers. By posting this project on Transifex, Github, and other public places, and inviting you to participate, we are proposing an agreement that you will provide your improvements to Python's documentation or the translation of Python's documentation for the PSF's use under the CC0 license (available at https://creativecommons.org/publicdomain/zero/1.0/legalcode). In return, you may publicly claim credit for the portion of the translation you contributed and if your translation is accepted by the PSF, you may (but are not required to) submit a patch including an appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although nothing in this Documentation Contribution Agreement obligates the PSF to incorporate your textual contribution, your participation in the Python community is welcomed and appreciated.

You signify acceptance of this agreement by submitting your work to the PSF for inclusion in the documentation.

Contributing to the Translation

How to Contribute

You can contribute using:

Contributing using Github

Prerequisites:

Let's start:

You'll need to fork the python-docs-fr clicking its Fork button. This creates a copy of the whole project on your github account: a place where you have the rights to do modifications.

Step by step:

# Git clone your github fork using ssh (replace JulienPalard):
git clone [email protected]:JulienPalard/python-docs-fr.git

# Go to the cloned directory:
cd python-docs-fr/

# Add the upstream (the public repository) using HTTPS (won't ask for password):
git remote add upstream https://github.com/python/python-docs-fr.git

All the translations must be made on the latest release. We never translate on an oldest version, by example, the latest python release is python 3.7, we don't want to translate directly on the python 3.5 release. If needed translations would be backported on the oldest versions by the documentation team <https://www.python.org/dev/peps/pep-8015/#documentation-team>.

First, you need to find a file to work on. You can use potodo <https://github.com/seluj78/potodo>. Install it (pip install potodo in a venv) and then run the command potodo in your cloned fork. From the list it spits out, you can choose any file that is not reserved. We recommend not starting with a file from ``c-api` as it is very technical.

Once you've choosen a file, please open an issue telling you're working on it, to block someone from working on it.

Now you're ready to start a work session, each time you'll start a new task, start here:

# To work, we'll need a branch, based on an up-to-date (freshly fetched)
# upstream/3.7 branch, let's say we'll work on glossary so we name
# the branch "glossary":
git fetch upstream
git checkout -b glossary upstream/3.7

# You can now work on the file, typically using poedit,
poedit directory/file.po

# When everything is clear (syntax errors from Sphinx, html rendering,
# semantics, typography),
# you can commit your work with a nice explicit message:
git commit -a -m "Working on glossary."

# Then push your modifications to your github clone,
# as they are ephemeral branches, let's not configure git to track them all,
# "origin HEAD" is a "special" syntax to say "Push on origin,
# on a branch with the same name as the local one",
# it's nice as it's exactly what we want:
git push origin HEAD

# The previous command will print you a link to open a PR on github.
# If you missed it, just go to
# https://github.com/python/python-docs-fr/ and a nice "Compare & pull request"
# button should appear after a few seconds telling you can ask for a pull request.

# Now someone is reviewing your modifications, and you'll want to fix their
# findings, get back to your branch
# (in case you started something else on another branch):
git checkout glossary
# Fix the issues, then commit again:
git commit -a -m "glossary: small fixes."
git push origin HEAD

You may have noted that this looks like a triangle, with a missing segment:

  • You're fetching from upstream (public common repo on github)
  • You're pushing to origin (your clone on github)

So yes it's the work of someone to add the last segment, from your origin to the public upstream, to "close the loop", that's the role of the people who merges pull requests after proofreading them.

You may also have noted you never ever commit on a version branch (3.6, 3.7, ...), only pull from them, consider them read-only you'll avoid problems.

Before commiting, you should use grammalecte to check for your translations.

What to translate

You can start with easy tasks like reviewing fuzzy entries to help keeping the documentation up to date (find them using make fuzzy).

You can also proofread already translated entries, and finally translate untranslated ones (find them using make todo)..

  • Do not translate content of :ref:... and :term:...
  • Put english words, if you have to use them, in italics (surrounded by stars).
  • :: at the end of some paragraphs have to be translated to `` : ::`` in French to place the space before the column.
  • If you translate a link title, please translate the link too (typically if it's Wikipedia and the article has a translation). If no translation of the target exists, do not translate the title.

The case of "::"

From the reStructuredText point of view, :: glued at the end of a word means "output : and introduce a code block", but a :: after a space means "Just introduce a code block".

So in english rst, we see either blah blah:: or blah blah. ::.

In french, we're putting a no-break space before our columns, like: Et voilà :.

Using no-break space in rst is natural, you'll simply write Et voilà ::, as the :: is not precedded by a normal space it will output the column and introduce the code block, you're done.

If you don't know how to type a no-break space there's a trick, translate column column by space, column, space, column column. the "space column" will render your space and your column as french needs, and the trailing "space column column" will output nothing and introduce the code block. No it does not magically inserts a no-break space, so it's still not really valid french. Yes, better learn how to type no-break space.

Where to get help

The coordinator for this translation is mdk.

Feel free to ask your questions on the #python-fr channel on freenode (does not require registration) or the AFPy traductions mailing list.

Translation Resources

Glossary

For consistency in our translations, here are some propositions and reminders for frequent terms you'll have to translate, don't hesitate to open an issue if you disagree.

To easily find how a term is already translated in our documentation, you may use find_in_po.py.

Term Proposed Translation
-like -compatible
abstract data type type abstrait
argument argument (Don't mix with parameter)
backslash antislash, backslash
bound lier
bug bogue, bug
built-in native
call stack pile d'appels
debugging débogage
deep copy copie récursive (préféré), ou copie profonde.
double quote guillemet
e.g. e.g. (pour exempli gratia)
garbage collector ramasse-miettes
identifier identifiant
immutable immuable
installer installateur
interpreter interpréteur
library bibliothèque
list comprehension liste en compréhension (liste en intension est valide, mais nous ne l'utilisons pas)
little-endian, big-endian petit-boutiste, gros-boutiste
mutable muable
namespace namespace, espace de noms
parameter paramètre
prompt invite
raise lever
regular expression expression rationnelle, expression régulière
return renvoie, donne (on évite "retourne" qui pourrait porter à confusion).
simple quote guillemet simple, apostrophe (apostrophe is to glue, guillemet is to surround)
socket socket
statement instruction
subprocess sous-processus
thread fil d'exécution
underscore tiret bas, underscore
expression expression

Project History

This project was started around 2012 by afpy members, in 2017 this project became the official french Python documentation translation thanks to PEP 545.

Simplify git diffs

Git diffs are often crowded with useless line number changes, like:

-#: ../Doc/library/signal.rst:406
+#: ../Doc/library/signal.rst:408

To tell git they are not usefull information, you can do the following after ensuring ~/.local/bin/ is in your PATH.

cat <<EOF > ~/.local/bin/podiff
#!/bin/sh
grep -v '^#:' "\$1"
EOF

chmod a+x ~/.local/bin/podiff

git config diff.podiff.textconv podiff

Maintenance

All those snippets are to run from the root of a python-docs-fr clone, and some expect to find an up-to-date CPython clone near to it, like:

~/
├── python-docs-fr/
└── cpython/

To clone CPython you may use:

git clone --depth 1 --no-single-branch https://github.com/python/cpython.git

This avoids to download the whole history (not usefull to build documentation) but still fetches all branches.

Merge pot files from CPython

make merge

Find fuzzy strings

make fuzzy

Run a test build locally

make

Synchronize translation with Transifex

You'll need the transifex-client and powrap from Pypi.

You'll need to configure tx via tx init if not already done.

First propagate known translations locally:

pomerge --from-files **/*.po --to-files **/*.po
powrap --modified
git commit -m "Propagating known translations."

Then pull from transifex:

pomerge --from-files **/*.po
tx pull -f
pomerge --to-files **/*.po
pomerge --from-files **/*.po
git checkout -- .
pomerge --to-files **/*.po
powrap --modified
git commit -m "tx pull"
tx push -t -f