docs: drop the removed CMake presets from the mujoco_xr example - #996
docs: drop the removed CMake presets from the mujoco_xr example#996jiwenc-nv wants to merge 1 commit into
Conversation
Commit f8b5eaa deleted CMakePresets.json and rewrote the build pages, but examples/mujoco_xr kept telling readers to run `cmake --preset py3.12` and to look for the build venv under build/cmake-cpython-312 — commands that now fail outright. Point them at `cmake -B build` instead, in the README and in the two error messages that name a configure command. The example's tests pinned requires-python to ==3.12.*, which only held because the preset always selected 3.12; against the 3.11 default that pin makes `ctest -L mujoco_xr` fail before it runs. Widen it to the >=3.11,<3.14 range the rest of the repo uses — tests/CMakeLists.txt already passes the real build interpreter to `uv run --python`, which is what guarantees the _mujoco_xr*.so ABI match. Also drop the -py3.12 suffix from the build directories the docs and the version-mismatch error suggest: one tree named build/ is enough, and the suffix tied a directory name to an interpreter that the -D flag already selects. Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
|
📝 Docs preview is not auto-deployed for fork PRs. A maintainer with write access to |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (8)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 WalkthroughWalkthroughThe changes update Python-version build guidance across CMake errors and documentation. Users must delete the existing Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to The PR updates stale build instructions and aligns the example tests with supported Python versions; no actionable merge-blocking risk remains after normal checks. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
1 participant
CMakePresets.jsonwent away in f8b5eaa, which rewrote the Sphinx build pages but missedexamples/mujoco_xr/. Its README still tells readers to runcmake --preset py3.12and to find the build venv underbuild/cmake-cpython-312/, and two error messages — the configure-time "mujoco_xr: skipped" and the runtime ABI-mismatchImportError— still namecmake --presetas the remedy. All now point atcmake -B build.One behavioural fix rides along.
tests/pyproject.tomlpinnedrequires-python = "==3.12.*", which only held because the preset forced 3.12; against the 3.11 default,ctest -L mujoco_xrfails before a test runs. It is now>=3.11,<3.14, matching the example's own pyproject and thecamera_viz/testsprecedent it cites. The ABI match with_mujoco_xr*.socomes fromtests/CMakeLists.txtpassing the build interpreter touv run --python, which the pin never did.The docs and the version-mismatch
FATAL_ERRORalso stop suggestingbuild-py3.12/— one tree namedbuild/is enough, since-DISAAC_TELEOP_PYTHON_VERSIONalready selects the interpreter.Testing
SKIP=check-copyright-year pre-commit run --all-files— passed.make current-docs(sphinx-build -W --keep-going) — build succeeded.ctestnot run: no configured build tree on this host.Summary by CodeRabbit
build/directory and direct CMake commands.