Documentation is built and uploaded automatically to docs.texta.ee website.
For testing the documentation locally, use following command to build HTML:
sphinx-build source public
If Sphinx not installed:
pip install sphinx
How to translate or change things?
Everyone, who adds something to our docs are required to translate the changes as well.
Translating:
#: ../../source/api.rst:4
msgid "This is an amazing sentence in English :ref:`API reference <api_reference>`."
msgstr "See on vägev lause eesti keeles :ref:`API reference <api_reference>`."
(“#, fuzzy” shows that this part was changed and needs to be retranslated)
Changing in English version and translating:
make gettext
and
sphinx-intl update -p build/gettext -l en -l et
(this adds the changes you made in English files to the Estonian .po files, but does not delete translations made before in case those were not changed in English. The changed texts are marked with “#, fuzzy”)If you want to check your translations or English versions, use:
sphinx-build -b html -D language=en source public
and
sphinx-build -b html -D language=et source public/et