The documentation uses Sphinx. In order to compile the source files, the sphinx python module is required:
$ pip install sphinx
You are now ready to compile the documentation. Change the directory to the docs
directory where the source files and the build are located:
$ cd docs
Every time that the source files are modified the build needs to be run:
$ make html
The result of the build is an html whose index is inside docs/_build/html/index.html
. If you are inside de docs
folder:
$ open _build/html/index.html