Actualizar la documentación para indicar que el clon debe ser recursivo

[kbiggers]

Actualizar la documentación para indicar que el clon debe ser recursivo

closes #3352

[github-actions]

All entries translated, horray! 🎉

[rtobar]

@kbiggers los cambios de este PR están basados en tu branch donde tradujiste lexical_analysis.po. ¿Puedes hacer un rebase sobre la rama 3.13? ¡Gracias!

En cuanto a los cambios mismo, si bien son correctos, creo que no son óptimos. Hacer el clone recursivo es mucho más costoso que hacer el clone sólo de python-docs-es, y para lo único que se necesita el submódulo de cpython es para construir la documentación -- que creo que muchos usuarios no realizarn de forma local. Por otro lado, cuando uno hace make build el submódulo se inicializa si no está inicializado. Dado todo esto,, creo que tienen más sentido otras alternativas donde no se hace un clon recursivo:

1. Cambiar las instrucciones para que el comando pip install indique que hay que instalar pip install requirements-own.txt en vez de requirements.txt. Ese sería un cambio bien simple, ya que sabemos que el resto de la infraestructura ya funciona con los archivos requirements*.txt tal como están.
2. Renombrar requirements.txt a requirements-build.txt y requirements-own.txt a requirements.txt. Así queda claro que el primero contiene las dependencias necesarias para hacer el build, mientras que el segundo, más implícitamente, contiene las dependencias que se necesitan para hacer la traducción. Dados los cambios de nombres, se requeriría un par de cambios en los jobs de CI tal vez, y en el Makefile, pero nada muy complejo.

Personalmente yo me decantaría por la primera opción, pero sería bueno escuchar otras opiniones. Y, en primer lugar, saber si ésta es una opción válida en primer lugar.

[kbiggers]

Gracias por la respuesta @rtobar! Coincido contigo que la opción 1 parece la más simple, y la mejor por ahora. Tal vez podemos añadir algún comentario extra a la guía sobre como construir la documentación de forma local (por si acaso algún usuario quiere hacerlo)?

[cmaureir]

Este paso no es necesario, porque make build va a llamar a setup y do_build.
Dentro de setup tienes:

setup: venv
    git submodule sync
    git submodule update --init --force --depth 1 $(CPYTHON_PATH)

[kbiggers]

hmm en un nuevo clon no puedo construir la documentación:

(venv) ➜  temp git:(3.13) make build 
if [ ! -d /home/krbiggers/temp/venv ]; then                                          \
        /home/krbiggers/temp/venv/bin/python3 -m venv --prompt python-docs-es /home/krbiggers/temp/venv;             \
fi
/home/krbiggers/temp/venv/bin/python -m pip install -q -r requirements.txt
ERROR: Could not open requirements file: [Errno 2] No such file or directory: 'cpython/Doc/requirements.txt'
make: *** [Makefile:66: venv] Error 1
(venv) ➜  temp git:(3.13)  

Creo que es pq dentro de la configuración de venv intentamos pip install el archivo requirements.txt antes de actualizar el submodule de cpython.

Tal vez debemos actualizar el paso venv para solo intentar instalar las dependencias de requirements-own.txt ?

[rtobar]

Tal vez debemos actualizar el paso venv para solo intentar instalar las dependencias de requirements-own.txt ?

Tiene sentido, sí. Y después actualizar además el paso build para que instale requirements.txt, y así se instalen las dependencias para realizar el build.

Ojo también que tus cambios aún están basados sobre tu branch con cambios de lexical_analysis.po, cuando debieran estar basados en la rama 3.13.