Documentation

Documentation is available here and here are some references on how to work with it.

Dependencies

pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints

cd docs
sphinx-build -b html source build

This udapte should be done after any update of the main branch so that the documentation is synchronised with the main version of the repository.

git checkout gh-pages
git rebase main
cd docs
sphinx-build -b html source ./
git commit -a
git push