Document

Using Sphinx

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

make docs

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

Opening doc

make open_docs

Or simply open docs/_build/html/index.html.

Remark that a

make docs_and_open_docs

conveniently builds and opens the doc at the end.

Last updated