parente/helloworld-transifex-rtd

Translation CI/CD workflow involving Sphinx, Transifex, GitHub Actions, and ReadTheDocs

helloworld-transifex-rtd

This project demonstrates a continuous integration and deployment workflow involving Sphinx, Transifex, GitHub Actions, and ReadTheDocs. I created it to supplement the documentation in jupyter/jupyter#475 describing how to enable translations of Sphinx documentation for Project Jupyter.

Points of interest

• The Sphinx configuration docs/source/conf.py which configures the path where .po language files reside
• The GitHub Action workflow .github/workflows/gettext.yml which regenerates and commits the English .po files automatically any time the English Markdown or restructuredText documentation changes on the master branch
• https://github.com/parente/helloworld-transifex-rtd/commit/9c2b4212ad - an example commit made by the GitHub Action workflow after I added a new text to second.md
• #1 - an example pull request submitted by Transifex after I translated all of the English text in the first.po file to Spanish using the Transifex web app
• https://helloworld-transifex-rtd.readthedocs.io/en/latest/ - the English docs hosted on ReadTheDocs
• https://helloworld-transifex-rtd.readthedocs.io/es/latest/ - the translated Spanish docs hosted on ReadTheDocs