Guides (new generation)

Les Fruits Défendus pick-leaders and Saskatoon users guides.

Online version of the guides (work in progress): French, English.

Contribute to the guides

The guides website is built using Sphinx.

The source file can be either Markdown (.md) or ReStructuredText (.rst) files.

Build documentation site

To build the documentation sites, run:

tox -e docs

To serve the English documentation site, run:

python3 -m http.server -d ./build/docs/en

To serve the French documentation site, run:

python3 -m http.server -d ./build/docs/fr

Update translation files

After modifications, update translation files:

tox -e trans

Translate the files

The translation files are located into the docs/source/_locales/fr/LC_MESSAGES folder. You can directly edit the .po files or use an editor.

Test the documentation

Build the documentation sites and fail on warnings

tox -e testdocs
tox -e testdocs-fr

Build statuses

English site:

French site: