README.md

Documentation

The source code documentation is hosted using GitHub Pages at deeprob-kit.readthedocs.io/en/latest.

The documentation is generated automatically by Sphinx, using sources stored in the docs directory (with a Read-the-Docs theme).

If you wish to build the documentation yourself, you will need to install the required dependencies from the root directory as follows.

pip install -e .[docs]

Finally, it's possible to execute the Makefile script as following:

# Clean existing documentation (optional)
make clean
# Build HTML documentation
make html

The output HTML documentation can be found inside the _build directory.