thomask
/
social-doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add instructions for new pages and internationalisation

This commit is contained in:
Thomas Karpiniec 2018-08-28 19:57:27 +10:00
parent 9552f145e2
commit 1b2765cfcb
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.sphinx
View File

@ -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.