Skip to content

Commit 2066a26

Browse files
humitoshumitos
authored
Merge branch '3.7' into zlib
2 parents 179e96c + 4248a33 commit 2066a26

21 files changed

+1146
-762
lines changed

‎.gitignore

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
*.mo
22
/_build/
33

4+
# Submodules to avoid issues
5+
cpython
6+
.migration/tutorialpyar
7+
8+
# Files overriden by our scripts
9+
Doc/tools/templates/customsourcelink.html
10+
Doc/tools/templates/indexsidebar.html
11+
Doc/CONTRIBUTING.rst
12+
Doc/translation-memory.rst
13+
Doc/upgrade-python-version.rst
14+
locales/
15+
416
# Byte-compiled / optimized / DLL files
517
__pycache__/
618
*.py[cod]
@@ -47,4 +59,4 @@ coverage.xml
4759

4860
# Ides
4961
.vscode/
50-
.idea/
62+
.idea/

‎.overrides/CONTRIBUTING.rst

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
Guía para contribuir en la traducción
2+
=====================================
3+
4+
¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
5+
Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
6+
7+
.. note::
8+
9+
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
10+
11+
12+
#. Crea un fork del repositorio_.
13+
14+
.. note::
15+
16+
Puedes consular la `ayuda oficial de GitHub`_, si lo deseas.
17+
18+
#. Clona el fork del repositorio que acabas de crear::
19+
20+
git clone git@github.com:<TU-USUARIO>/python-docs-es.git
21+
22+
#. Ingresa en la carpeta que `git clone` creó en tu computadora::
23+
24+
cd python-docs-es/
25+
26+
#. Agrega el repositorio original como "upstream"::
27+
28+
git remote add upstream https://github.com/pycampes/python-docs-es.git
29+
30+
#. Crea una branch nueva en base al artículo en el que vayas a trabajar.
31+
Por ejemplo, si vas a trabajar en el archivo ``glosario.po``, usa un nombre similar a::
32+
33+
git checkout -b traduccion-glosario
34+
35+
#. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit_ y empezar a traducir.
36+
37+
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
38+
39+
git commit -am 'Traducido archivo {nombre de archivo}'
40+
git push origin traduccion-glosario
41+
42+
#. No olvides añadir tu nombre al archivo ``TRANSLATORS`` si no lo has hecho todavía.
43+
Los nombres se encuentran ordenados alfabéticamente por apellido.
44+
45+
#. Luego ve a tu página de GitHub y propone hacer un Pull Request.
46+
47+
.. note::
48+
49+
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_ si lo deseas.
50+
51+
52+
¿Qué archivo traducir?
53+
----------------------
54+
55+
Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo.
56+
El proceso para traducir un archivo es el siguiente:
57+
58+
59+
#. Elige cualquier de los que *no están asignados* a otra persona.
60+
#. Deja un comentario en el issue diciendo que quieres trabajar en él.
61+
#. Espera a que un administrador te asigne el issue.
62+
#. ¡Empieza a traducir!
63+
64+
65+
66+
A tener en cuenta
67+
-----------------
68+
69+
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.
70+
* Si tienes que palabras en inglés, debes ponerlas en *italics* (rodeadas por asteristicos)
71+
* Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
72+
En caso de que no haya una traducción del artículo en Wikipedia, deja el título sin traducir.
73+
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con algunos términos.
74+
75+
76+
77+
.. note::
78+
79+
También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.
80+
81+
82+
83+
Previsualizar los cambios
84+
-------------------------
85+
86+
Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
87+
88+
Read the Docs
89+
`````````````
90+
91+
Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
92+
Ahí, debería haber uno que diga ``docs/readthedocs.org:python-docs-es``, y al lado un link de "Details".
93+
Haciendo click en ese link, deberías poder ver una versión de la documentación con tus cambios.
94+
95+
Construcción local
96+
``````````````````
97+
98+
Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git clone``, puedes ejecutar::
99+
100+
make build
101+
102+
Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.
103+
Puedes ver el con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
104+
105+
make serve
106+
107+
Y luego accediendo a http://localhost:8000/
108+
109+
110+
.. _repositorio: https://github.com/PyCampES/python-docs-es
111+
.. _ayuda oficial de GitHub: https://help.github.com/es/github/getting-started-with-github/fork-a-repo
112+
.. _ayuda oficial de GitHub para crear un Pull Request: https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
113+
.. _poedit: https://poedit.net/
114+
115+
.. _nuestro canal de Telegram: https://t.me/python_docs_es
116+
.. _Memoria de traducción: https://python-docs-es.readthedocs.io/es/3.7/translation-memory.html
117+
.. _lista de issues en GitHub: https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

‎.overrides/README.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Overrides
2+
=========
3+
4+
This directory is recursively copied into `cpython/Doc`.
5+
It needs to have the same structure than `cpython/Doc`.
6+
7+
It allows us
8+
9+
- to have our own `CONTRIBUTING.rst` guide
10+
- change the index sidebar with links that are interesting for translators
11+
- etc

‎.overrides/tools/templates/customsourcelink.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{%- if show_source and has_source and sourcename %}
2+
<div role="note" aria-label="source link">
3+
<h3>{{ _('This Page') }}</h3>
4+
<ul class="this-page-menu">
5+
<li><a href="{{ pathto('bugs') }}">{% trans %}Report a Bug{% endtrans %}</a></li>
6+
<li>
7+
<a href="https://github.com/PyCampES/python-docs-es/blob/{{ version }}/{{ sourcename|replace('.rst.txt', '.po') }}"
8+
rel="nofollow">{{ _('Show Source') }}
9+
</a>
10+
</li>
11+
</ul>
12+
</div>
13+
{%- endif %}

‎.overrides/tools/templates/indexsidebar.html

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<h3>¡Ayúdanos a traducir!</h3>
2+
<ul>
3+
<li><a href="CONTRIBUTING.html">Guía para contribuir</a></li>
4+
</ul>
5+
6+
<h3>Recursos</h3>
7+
<ul>
8+
<li><a href="https://mail.python.org/mailman3/lists/docs-es.python.org/">Lista de correos</a></li>
9+
<li><a href="https://t.me/python_docs_es">Canal de Télegram</a></li>
10+
<li><a href="https://github.com/PyCampES/python-docs-es">Repositorio GitHub</a></li>
11+
</ul>

‎.overrides/translation-memory.rst

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
=======================
2+
Memoria de traducción
3+
=======================
4+
5+
6+
Esta página contiene la Memoria de Traducción, con todos los términos que hemos ido teniendo dudas,
7+
y coordinamos cuál era la mejor traducción dado el contexto.
8+
9+
Si quieres ver cómo se ha utilizado un término anteriormente, puedes utilizar la herramienta
10+
``find_in_po.py`` que muestra dónde se usó ese término: original y traducción lado a lado:
11+
12+
.. code-block:: text
13+
14+
$ python scripts/find_in_po.py docstring
15+
╒════════════════════════════════════════════════════════════════════════════════════════════════╤═══════════════════════════════════════════════════════════════════════════════════════════════╕
16+
│ The first statement of the function body can optionally be a string literal; this string │ La primera sentencia del cuerpo de la función puede ser opcionalmente una cadena de texto │
17+
│ literal is the function's documentation string, or :dfn:`docstring`. (More about docstrings │ literal; esta es la cadena de texto de documentación de la función, o :dfn:`docstring`. │
18+
│ can be found in the section :ref:`tut-docstrings`.) There are tools which use docstrings to │ (Puedes encontrar más acerca de docstrings en la sección :ref:`tut-docstrings`.). Existen │
19+
│ automatically produce online or printed documentation, or to let the user interactively browse │ herramientas que usan las ``docstrings`` para producir documentación imprimible o disponible │
20+
│ through code; it's good practice to include docstrings in code that you write, so make a habit │ en línea, o para dejar que los usuarios busquen interactivamente a través del código; es una │
21+
│ of it. │ buena práctica incluir ``docstrings`` en el código que escribes, y hacerlo un buen hábito. │
22+
├────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
23+
│ Here is an example of a multi-line docstring:: │ Este es un ejemplo de un ``docstring`` multi-línea:: │
24+
├────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
25+
│ Use docstrings. │ Usar ``docstrings``. │
26+
├────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
27+
28+
29+
Éstos son las palabras que hemos coordinado hasta el momento:
30+
31+
32+
loop
33+
Bucle. ``tutorial/controlflow.po``
34+
35+
handle exception
36+
Gestionar excepción. ``tutorial/inputoutput.po``
37+
38+
docstring
39+
docstring. ``library/idle.po``

‎CONTRIBUTING.rst

-102
This file was deleted.

0 commit comments

Comments
 (0)