Files
concrete/docs/dev/DOCUMENTING.md
2021-09-08 11:27:02 +02:00

395 B

Documenting

Making docs with Sphinx

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

make docs

The documentation contains both files written by hand by developpers 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