diff --git a/README.sphinx b/README.sphinx index f7797f5..6c00e6c 100644 --- a/README.sphinx +++ b/README.sphinx @@ -27,3 +27,19 @@ To generate the Spanish translations: make translations The Spanish version will be generated in `docs/_build/spanish`. + +New Pages and Internationalisation +---------------------------------- +Translation works using `sphinx-intl`. It creates .po files where English phrases can be converted to other languages. + +To add a page and create the .po file for translation: + +1. Set up the virtualenv as described above. Activate it and install the requirements. +2. Create a new file for the page such as `admin/file.rst`. +3. Edit it and make it correct in English (`make html`). +4. Open terminal to `/docs` and run `make gettext`. This creates files under `_build/locale` +5. Run `sphinx-intl update -p _build/locale/ -l es` to refresh the .po files +6. Edit .po files under `locale/es/LC_MESSAGES/...` +7. Run `make translations` to generate the Spanish version +8. Commit changes. +