Documentation

The documentation is written using Sphinx. First, make sure Sphinx is installed on your system:

sudo apt install python3-sphinx

Also install LaTeX for displaying equations:

sudo apt install texlive-latex-base

sudo apt install texlive-latex-extra

sudo apt install dvipng

Then run

make html

to build the HTML documentation. The home page of the documentation is at doc/build/html/index.html.

The following additional packages are needed for making PDF files:

sudo apt install latexmk

sudo apt install texlive-xetex

sudo apt install latex-cjk-all