concrete/docs/dev/howto/DOCUMENTING.md

Documenting

Using Sphinx

One can simply create docs with Sphinx and open them, by doing:

make docs

Remark that this needs to be done in docker.

The documentation contains both files written by hand by developpers (the .md files) and files automatically created by parsing the source files.

Opening doc

On macOS, one can do

make open_docs

On other systems, simply open docs/_build/html/index.html