Python API Reference

The full dartpy API reference is built from the module pages under docs/python_api/. Sphinx imports a live dartpy module when one is available; otherwise docs/readthedocs/conf.py falls back to the committed stubs under python/stubs/dartpy so Read the Docs renders the current repository API shape without pinning an older release wheel.

Note

Local pixi run docs-build uses the same fallback path unless the current shell already exposes a built dartpy module. Use pixi run api-docs-py when you need a local API build backed by the freshly compiled extension.

Getting Started

To explore the bindings locally:

pip install dartpy
python - <<'PY'
import dartpy as dart
world = dart.World()
print(world.get_gravity())
PY

Module Reference