Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 694 Bytes

documentation.rst

File metadata and controls

32 lines (17 loc) · 694 Bytes

Documentation

We use sphinx doc and sphinx-rtd-theme. Requirements are included.

A container based on sphinx image is created using docker-compose-dev.yml, documentation is built in watch mode thanks to sphinx-autobuild.

To compile and test documentation on local environment, run :

Access to documentation built in html : http://0.0.0.0:8800

Translate documentation

  • Generate .pot if needed
  • Generate .po files