Crear GitHub Actions o Travis para construir el sitio mkdocs

[adriaanbd]

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