This repository currently is maintained in English and Japanese.
Documentation in this repository includes .md files for GitHub, and .rst files for our Read the Docs portal at https://baikonur.dev .
We use Sphinx for documentation as required by Read the Docs, and Transifex for managing our tranlations.
Make sure to have the following tools installed:
- Sphinx
- sphinx-rtd-theme
- Transifex CLI
- gettext
Installation instructions for macOS:
$ pip3 install sphinx sphinx-rtd-theme
$ pip3 install transifex-client
$ brew install gettextContact one of the Baikonur Organisation owners for a Transifex account and API keys necessary for translations updates.
# 1. Generate .po and .pot files from .rst files
$ cd docs
$ sphinx-build -b gettext . _build/gettext
# 2. Push .po files for translation to Transifex
$ tx push -s
# 3. Translate new strings at Transifex
# 4. After translations are finished and reviewed, pull translations from Transifex to local
$ tx pull
# 5. Check if translations are pulled correctly, commit and push changes
# Note: tx pull also creates binary .mo files, make sure to include them as well
# Changes pushed to branches including master will be automatically deployed to baikonur.dev
# Your branch should appear as a new version in version switcher in the bottom-left
# 6. In case .mo files are not updated correctly, try following command to rebuild .mo locally
$ find ./ -name '*.po' | sed 's/^.\/\///' | sed 's/.po$//' | xargs -I% sh -c 'msgcat %.po | msgfmt -o %.mo -' Consult Read the Docs documentation