https://github.com/parente/helloworld-transifex-rtd

Translation CI/CD workflow involving Sphinx, Transifex, GitHub Actions, and ReadTheDocs
https://github.com/parente/helloworld-transifex-rtd

github-actions i18n readthedocs sphinx transifex translation

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/parente/helloworld-transifex-rtd
• Owner: parente
• License: bsd-3-clause
• Created: 2020-06-28T21:36:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-30T12:36:09.000Z (over 4 years ago)
• Last Synced: 2024-10-10T19:22:36.394Z (about 1 month ago)
• Topics: github-actions, i18n, readthedocs, sphinx, transifex, translation
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

https://github.com/jupyter/jupyter/pull/475 describing how to enable translations of Sphinx

documentation for Project Jupyter.

![Translation CI/CD](https://raw.githubusercontent.com/parente/jupyter/translation-doc/docs/source/contrib_docs/static/translation-ci-cd.png)

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`

- https://github.com/parente/helloworld-transifex-rtd/pull/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