About multilingual user manual

Hi,
richard.pare.

I don't know Sphinx-doc. But I already have some ranslation for old documentation. I could participate in translation.

Could you send me some instructions?

First, You must install Python and Python Image Lybrary (PIL).
Second, You must install Sphinx :
- pip install Sphinx
- pip install Sphinx-intl

If you want produce PDF documentation on Windows, you must install MiKTeX because Latex is not supported under Windows.


Download source code from branch 5.1.

Go to on /docs/user directory.

The documentation is in RST file.

If you want to built documentation in HTML or PDF format.

Command: make html or make latexpdf

--- Translation ---

See: sphinx-doc.org/latest/intl.html

Under /docs/user/locale directory, you can see PO and MO files.

PO : Translation files
MO : Formatted translation files

Under /docs/user/_built/locale, you can see POT files.

- Each RST file has a POT file.
- POT is a reference file to all string translable from the original document.
- Use by Pootle to update PO files.

Instructions :

Command: make gettext

- Update the POT files

Command: sphinx-intl update -l ru -p _build/locale

- Update PO files for this language.
- PO files localized in /docs/user/locale/ru/LC_MESSAGES/
- You made the translate in the POT files.

Command: sphinx-intl build

- Update MO files.

Command: make SPHINXOPTS="-Dlanguage=ru" html or make SPHINXOPTS="-Dlanguage=ru" latexpdf

- Produce HTML or PDF document.

---

The repository content the first draft of user guide.
Do not start the translation for now. Wait the official release.
But you can try to translate into Russian.
The translation is well in a Latin language.
Russian language, I do not know.

Keep me informed.