README.rst

Repository for 10Darts documentation

Write documentation

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

Build documentation

To build the documentation, you need to be able to run Python code in your machine. We recommend to use virtualenvwrapper to handle virtual envs with Python, and we are going to asume you have installed it.

Insall requirements

You only have to do this once:

$ mkvirtualenv 10darts-documentation
(10darts-documentation) $ pip install -r requirements.txt

Translations

First, activate the virtualenv:

$ workon 10darts-documentation

Extract document’s translatable messages into pot files:

(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:

$ workon 10darts-documentation
(10darts-documentation) $ make html

Upload

After commit and push run the following command:

$ workon 10darts-documentation
(10darts-documentation) $ ./deploy.sh