Skip to content

Commit 315c60c

Browse files
committed
clean master branch
1 parent 784fe4e commit 315c60c

File tree

512 files changed

+3
-335429
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

512 files changed

+3
-335429
lines changed

.gitignore

-1
This file was deleted.

Makefile

-85
This file was deleted.

README.rst

+3-281
Original file line numberDiff line numberDiff line change
@@ -28,285 +28,7 @@ You signify acceptance of this agreement by submitting your work to
2828
the PSF for inclusion in the documentation.
2929

3030

31-
Contributing to the Translation
32-
-------------------------------
31+
python-docs-it source code
32+
--------------------------
3333

34-
How to Contribute
35-
~~~~~~~~~~~~~~~~~
36-
37-
You can contribute using:
38-
39-
- Github
40-
- `transifex <https://www.transifex.com/python-doc/public/>`_
41-
- Or just by opening `an issue on github <https://github.com/python/python-docs-it/issues>`_
42-
43-
44-
Contributing using Github
45-
~~~~~~~~~~~~~~~~~~~~~~~~~
46-
47-
Prerequisites:
48-
49-
- A `github account <https://github.com/join>`_.
50-
- ``git`` `installed <https://help.github.com/articles/set-up-git/>`_ (for windows, see
51-
https://gitforwindows.org/).
52-
- A ``.po`` file editor (Use `poedit <https://poedit.net/>`_
53-
if you don't already have one).
54-
55-
56-
Let's start:
57-
58-
You'll need to fork the `python-docs-it
59-
<https://github.com/python/python-docs-it>`_ clicking its ``Fork``
60-
button. This creates a copy of the whole project on your github
61-
account: a place where you have the rights to do modifications.
62-
63-
Step by step:
64-
65-
.. code-block:: bash
66-
67-
# Git clone your github fork using ssh:
68-
git clone git@github.com:alessandrocucci/python-docs-it.git
69-
70-
# Go to the cloned directory:
71-
cd python-docs-it/
72-
73-
# Add the upstream (the public repository) using HTTPS (won't ask for password):
74-
git remote add upstream https://github.com/python/python-docs-it.git
75-
76-
All the translations must be made on the latest release.
77-
We never translate on an oldest version, by example, the latest python release
78-
is python 3.7, we don't want to translate directly on the python 3.5 release.
79-
If needed translations would be backported on the oldest versions by the
80-
`documentation team <https://www.python.org/dev/peps/pep-8015/#documentation-team>`.
81-
82-
Now you're ready to start a work session, each time you'll start a new task, start here:
83-
84-
.. code-block:: bash
85-
86-
# To work, we'll need a branch, based on an up-to-date (freshly fetched)
87-
# upstream/3.7 branch, let's say we'll work on glossary so we name
88-
# the branch "glossary":
89-
git fetch upstream
90-
git checkout -b glossary upstream/3.7
91-
92-
# You can now work on the file, typically using poedit,
93-
poedit directory/file.po
94-
95-
# When everything is clear (syntax errors from Sphinx, html rendering,
96-
# semantics, typography),
97-
# you can commit your work with a nice explicit message:
98-
git commit -a -m "Working on glossary."
99-
100-
# Then push your modifications to your github clone,
101-
# as they are ephemeral branches, let's not configure git to track them all,
102-
# "origin HEAD" is a "special" syntax to say "Push on origin,
103-
# on a branch with the same name as the local one",
104-
# it's nice as it's exactly what we want:
105-
git push origin HEAD
106-
107-
# The previous command will print you a link to open a PR on github.
108-
# If you missed it, just go to
109-
# https://github.com/python/python-docs-it and a nice "Compare & pull request"
110-
# button should appear after a few seconds telling you can ask for a pull request.
111-
112-
# Now someone is reviewing your modifications, and you'll want to fix their
113-
# findings, get back to your branch
114-
# (in case you started something else on another branch):
115-
git checkout glossary
116-
# Fix the issues, then commit again:
117-
git commit -a -m "glossary: small fixes."
118-
git push origin HEAD
119-
120-
121-
You may have noted that this looks like a triangle, with a missing segment:
122-
123-
- You're fetching from upstream (public common repo on github)
124-
- You're pushing to origin (your clone on github)
125-
126-
So yes it's the work of someone to add the last segment, from your
127-
origin to the public upstream, to "close the loop", that's the role of
128-
the people who merges pull requests after proofreading them.
129-
130-
You may also have noted you never ever commit on a version branch
131-
(``3.6``, ``3.7``, ...), only pull from them, consider them read-only
132-
you'll avoid problems.
133-
134-
135-
What to translate
136-
~~~~~~~~~~~~~~~~~
137-
138-
You can start with easy tasks like reviewing fuzzy entries to help
139-
keeping the documentation up to date (find them using ``make fuzzy``).
140-
141-
You can also proofread already translated entries, and finally
142-
translate untranslated ones (find them using ``make todo``)..
143-
144-
- Do not translate content of ``:ref:...`` and ``:term:...``
145-
- Put english words, if you have to use them, in *italics* (surrounded
146-
by stars).
147-
- If you translate a link title, please translate the link too
148-
(typically if it's Wikipedia and the article has a translation). If
149-
no translation of the target exists, do not translate the
150-
title.
151-
152-
153-
Where to get help
154-
~~~~~~~~~~~~~~~~~
155-
156-
The coordinator for this translation is `acucci <https://www.alessandrocucci.it/>`_.
157-
158-
Feel free to ask your questions on the ``#python-it`` channel on `freenode
159-
<https://webchat.freenode.net/>`_ (does not require registration)
160-
161-
162-
Translation Resources
163-
---------------------
164-
165-
- IRC channel `#python-it <http://irc.lc/freenode/python-it>`_ on freenode.
166-
- The `doc-sig mailing list
167-
<https://mail.python.org/mailman/listinfo/doc-sig>`_.
168-
- `deepl.com/translator <https://www.deepl.com>`_
169-
170-
171-
Glossary
172-
--------
173-
174-
For consistency in our translations, here are some propositions and
175-
reminders for frequent terms you'll have to translate, don't hesitate
176-
to open an issue if you disagree.
177-
178-
To easily find how a term is already translated in our documentation,
179-
you may use
180-
`find_in_po.py <https://gist.github.com/JulienPalard/c430ac23446da2081060ab17bf006ac1>`_.
181-
182-
========================== ===========================================
183-
Term Proposed Translation
184-
========================== ===========================================
185-
-like di tipo
186-
abstract data type tipo dato astratto
187-
argument argomento
188-
backslash barra rovescia, *backslash*
189-
bound legato a
190-
bug errore, *bug*
191-
built-in integrato
192-
call stack pila
193-
debugging *debugging*
194-
deep copy copia profonda, copia ricorsiva
195-
double quote doppi apici
196-
e.g. per esempio
197-
garbage collector *garbage collector*
198-
identifier identificatore
199-
immutable immutabile
200-
installer *installer*
201-
interpreter interprete
202-
library libreria
203-
list comprehension *list comprehension*
204-
little-endian, big-endian formato *little-endian*, formato *big-endian*
205-
mutable mutevole
206-
namespace spazio dei nomi
207-
parameter parametro
208-
prompt *prompt*
209-
raise sollevare
210-
regular expression espressione regolare
211-
return ritorno
212-
simple quote singoli apici
213-
socket *socket*
214-
statement dichiarazione
215-
subprocess sottoprocesso
216-
thread *thread*
217-
underscore *underscore*
218-
expression espressione
219-
========================== ===========================================
220-
221-
222-
Simplify git diffs
223-
------------------
224-
225-
Git diffs are often crowded with useless line number changes, like:
226-
227-
.. code-block:: diff
228-
229-
-#: ../Doc/library/signal.rst:406
230-
+#: ../Doc/library/signal.rst:408
231-
232-
To tell git they are not usefull information, you can do the following
233-
after ensuring ``~/.local/bin/`` is in your ``PATH``.
234-
235-
.. code-block:: bash
236-
237-
cat <<EOF > ~/.local/bin/podiff
238-
#!/bin/sh
239-
grep -v '^#:' "\$1"
240-
EOF
241-
242-
chmod a+x ~/.local/bin/podiff
243-
244-
git config diff.podiff.textconv podiff
245-
246-
247-
Maintenance
248-
-----------
249-
250-
All those snippets are to run from the root of a ``python-docs-it``
251-
clone, and some expect to find an up-to-date CPython clone near to it,
252-
like:
253-
254-
.. code-block:: bash
255-
256-
~/
257-
├── python-docs-it/
258-
└── cpython/
259-
260-
To clone CPython you may use:
261-
262-
.. code-block:: bash
263-
264-
git clone --depth 1 --no-single-branch https://github.com/python/cpython.git
265-
266-
This avoids to download the whole history (not usefull to build
267-
documentation) but still fetches all branches.
268-
269-
270-
Merge pot files from CPython
271-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272-
273-
.. code-block:: bash
274-
275-
make merge
276-
277-
278-
Find fuzzy strings
279-
~~~~~~~~~~~~~~~~~~
280-
281-
.. code-block:: bash
282-
283-
make fuzzy
284-
285-
286-
Run a test build locally
287-
~~~~~~~~~~~~~~~~~~~~~~~~
288-
289-
.. code-block:: bash
290-
291-
make
292-
293-
294-
Synchronize translation with Transifex
295-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296-
297-
You'll need the ``transifex-client`` and ``powrap``
298-
from Pypi.
299-
300-
You'll need to configure ``tx`` via ``tx init`` if not already done.
301-
302-
.. code-block:: bash
303-
304-
pomerge --from-files **/*.po
305-
tx pull -f
306-
pomerge --to-files **/*.po
307-
pomerge --from-files **/*.po
308-
git checkout -- .
309-
pomerge --to-files **/*.po
310-
powrap --modified
311-
git commit -m "tx pull"
312-
tx push -t -f
34+
You can check the latest sources switching to the `3.13` branch.

TRANSLATORS

-1
This file was deleted.

0 commit comments

Comments
 (0)