CollabXR is a mixed-reality classroom. See the docs!
- Create a virtual Python environment:
python3 -m venv .venv/ - Enter virtual environment:
source .venv/bin/activate(or.\.venv\Scripts\activate.batif on Windows) - Install dependencies:
pip install -r docs/requirements.txt - Optionally install esbonio language server for Sphnix (preferablly global):
pip install esbonio - Install Prettier for auto-formatting configs:
npm i -g prettier - Setup pre-commit hooks for code cleanliness:
pre-commit install
To build the site locally after setting up your environment:
- On Unix:
cd docs && make html - Your built static-site should appear under docs/builds/html/