Documentation¶

The documentation files are in /docs and written with Spinx-Doc in reStructuredText language. ReStructuredText is like Markdown with some extra features.

The docs can be build as HTML, PDF or E-PUB.

To build HTML files use:

$ docker-compose -f local.yml run --rm django make --directory docs html

The compiled HTML files are in /docs/_build/html.

When uploading the docs on https://readthedocs.io as a github hook, it will auto compile each version as HTML, PDF & E-PUB.