Repository for 10darts documentation

Write documentation

The documentation is written using reStructuredText as markup language, and compiled to HTML using Sphinx.

Insall requirements

You only have to do this once:

$ pipenv install

Translations

Extract document’s translatable messages into pot files:

$ pipenv shell
(10darts-documentation) $ make gettext

Setup/update locale:

(10darts-documentation) $ sphinx-intl update -p _build/gettext -l es -l en

Build mo files and make translated document:

(10darts-documentation) $ sphinx-intl build
(10darts-documentation) $ make -e SPHINXOPTS="-D language='en'" html

Compile documentation

To create the HTML version of the documentation, run these commands:

$ pipenv shell
(10darts-documentation) $ make html

Upload

After commit and push run the following command:

$ pipenv shell
(10darts-documentation) $ ./deploy.sh