pythonpanama / pythonpractico_ssg Goto Github PK

Sería buena idea incorporar GitHub Actions para hacer un build automático de la página cuando se hace un merge de un PR a main o algun otro branch.

Manualmente esto se logra con: % python -m mkdocs build.

Lo que queremos es:

1. Merge a main o a dev
2. Ejecución de % python -m mkdocs build --clean
3. Que los cambios se reflejen en el sub módulo git en la carpeta ./site que apunta a https://github.com/pythonpanama/pythonpractico/tree/1bd25d7dd339d31ea3830d554ccfedc2ced125f1
4. % cd ./site
5. % git commit -m 'built by $PR_NAME' donde PR_NAME es el nombre del PR que lo provocó o alguna otra variable generica que indique timestamp o alguna otra cosa

El template que utilizamos es readthedocs.

Documentación oficial al respecto:

• https://www.mkdocs.org/user-guide/deploying-your-docs/
• https://mkdocs.readthedocs.io/en/0.15.3/user-guide/deploying-your-docs/

Sin embargo, pienso que estos enlaces son más útiles:

• https://bluegenes.github.io/mkdocs-github-actions/
• https://medium.com/dev-genius/continuous-deployment-for-mkdocs-with-github-actions-7dceec87f0ea

El import statement debe estar en una nueva linea:
https://github.com/pythonpanama/pythonpractico_ssg/blame/main/docs/3.md#L1244

Actualmente:

Puede utilizar el format_map()método para aplicar formato de cadena a un diccionario de valores:
...bloque de codigo omitido...
Utiliza los mismos códigos que f-stringspero toma los valores del diccionario suministrado.

Debería leer:

Puede utilizar el `format_map()` método para aplicar formato de cadena a un diccionario de valores:
...bloque de codigo omitido...
Utiliza los mismos códigos que `f-strings` pero toma los valores del diccionario suministrado.

Actualmente:

Existe un método format()que puede aplicar formato a argumentos o argumentos de palabras clave.

Debería leer:

Existe un método `format()` que puede aplicar formato a argumentos o argumentos de palabras clave.

Traducir todos los bloques de codigo excepto el Traceback

Actualmente:
Los diccionarios son útiles cuando hay * muchos * valores diferentes y esos valores puede ser modificado o manipulado. Los diccionarios hacen que su código sea más legible.

Debería leer:
Los diccionarios son útiles cuando hay *muchos* valores diferentes y esos valores puede ser modificado o manipulado. Los diccionarios hacen que su código sea más legible.

Actualmente:

To get values from a dictionary use the key names.
...el resto omitido...

Esto debe ser traducido.