API documentation

Details

The API documentation is available online at:

• https://abr-ijs.github.io/robotblockset_python/

Manual generation

The repository includes a Sphinx configuration under docs for generating API documentation directly from module, class, method, and function docstrings.

Install the package together with the documentation dependency:

pip install -e ".[docs]"

Then build the HTML documentation:

sphinx-build -b html docs docs/_build/html

Open docs/_build/html/index.html in a browser after the build completes.

The Sphinx setup mocks optional backend dependencies such as ROS, MuJoCo, camera SDKs, and vendor-specific drivers so the API reference can be built without installing every robotics stack.