Repository navigation
docs: point source-build entry points at the shared prerequisites - #1361
Merged
Merged
Conversation
Link the OAK, Wuji and LeRobot pages to the whole Build from Source page so readers see the CMake version note in Prerequisites, and add the same pointer to the device pages, plugin READMEs and examples that run a top-level configure without one. Keep only plugin-specific packages inline. The camera_viz source-build prompt names the sections to follow and says that camera_viz needs Televiz, which builds only when the Vulkan headers and the CUDA toolkit are found. Signed-off-by: Ivan Yang <yifanyang@nvidia.com>
Contributor
|
No actionable comments were generated in the recent review.
 |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… | Write docstrings for the functions missing them to satisfy the coverage threshold. |
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main documentation change: directing source-build entry points to shared prerequisites. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 1 files. (21 skipped: 21 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
Finishing Touches: 💡 1
-
📝 Generate docstrings: 💡
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
Contributor
|
✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1361/ Built from commit 6f5d2d9. It may take a minute for the updated preview to appear. |
jiwenc-nv
approved these changes
Oct 28, 2026
ivany-nv
added a commit
that referenced
this pull request
Oct 28, 2026
#1361 rewrote the oglo_tactile system-deps block that this branch also edited. Keep its prerequisites link and narrowed apt line, and drop the pip lines: the example's pyproject and isaaccapture[cloudxr] now bring Pillow, NumPy and CuPy. Signed-off-by: Ivan Yang <yifanyang@nvidia.com>
This was referenced Oct 28, 2026
ivany-nv
added a commit
that referenced
this pull request
Oct 28, 2026
* examples(oxr): package under isaaccapture_examples Package the OpenXR examples while preserving the GPU test runner paths and plugin discovery. Part of #985. Signed-off-by: Jiwen Cai <jiwenc@nvidia.com> [Ivan Yang: rebased onto main past #1348, which moved body_tracking.rst, oak.rst and trackers.rst into subdirectories and left redirect stubs. The stubs keep main's text; the same path edits are applied to body_tracking/index.rst, cameras/oak.rst and trackers/index.rst. python/README.md is deleted as in the original; the prerequisites link that #1361 added to it is already in examples/oxr/README.md.] Signed-off-by: Ivan Yang <yifanyang@nvidia.com> * examples(oxr): move the CloudXR GPU test scripts to tests/ The test_*.py scripts are CI checks, not example code, so they move to tests/python/xr_runtime/ instead of shipping in the example package. The package keeps modular_example and modular_example_with_mcap. - deps/cloudxr/Dockerfile.test copies tests/python/xr_runtime/ to /app/tests, so run_tests_with_cloudxr.sh lists the scripts by bare name again and the image's default command still finds test_extensions.py. - The synthetic-hands, hand-inactive and OAK scripts find plugins through install_tree.plugins_dir(): the nearest install/plugins above the script, which is <checkout>/install/plugins or /app/install/plugins in the test image. They are no longer installed beside install/plugins. - Docs and the OAK plugin README link the scripts at their new path. - The example depends on isaaccapture[cloudxr], which both modules import for CloudXRLauncher, and no longer on numpy, which none imports. Its README lists the two modules and says to install isaaccapture first. - tests/AGENTS.md says what the directory is and who runs it. Signed-off-by: Ivan Yang <yifanyang@nvidia.com> * examples(oxr): fix run instructions, plugin lookup and output paths - README: the Python modules attach to or start CloudXR through CloudXRLauncher, which overwrites XR_RUNTIME_JSON, so the export is gone from both Python blocks. The README says how to stop the service, what --accept-eula does and how to use another runtime. The C++ blocks source ~/.cloudxr/run/cloudxr.env, as references/cloudxr.rst says, instead of exporting a file name the runtime never writes. - README: install isaaccapture as Build from source step 4 does, pinned to X.Y+local with --reinstall-package, into a venv made with the build's Python. CI runs only the scripts listed in run_tests_with_cloudxr.sh, and the README says so and how to run one by hand. - install_tree.plugins_dir() stops at the checkout root (VERSION plus CMakeLists.txt) or the test image's /app instead of walking to /, so a nested worktree no longer picks up another checkout's plugins. The three plugin scripts take --plugin-root for any other install prefix. - modular_example_with_mcap and test_oak_camera write their MCAP under ./recordings/, which the root .gitignore covers, and create it. - modular_example_with_mcap's docstring names McapRecordingConfig, not parameters DeviceIOSession.run() no longer takes. - The OAK page and plugin README call test_oak_camera.py a test script and give its run line; tests/AGENTS.md uses a repo-root path. Signed-off-by: Ivan Yang <yifanyang@nvidia.com> * examples(oxr): complete the system-runtime and OAK run instructions - references/cloudxr.rst: a system runtime also needs ISAAC_TELEOP_DISABLE_CXR_ENV_CHECKS, or OpenXRSession refuses to start without NV_CXR_RUNTIME_DIR. The oxr README links that section instead of restating half of it. - oxr README: the C++ examples start the service with --accept-eula, as references/cloudxr.rst does. - OAK page and plugin README: test_oak_camera.py loads the plugin from install/plugins, so it needs a full build and install, not only the camera_plugin_oak target, and isaaccapture in the active environment. - --plugin-root and --mode help use %(default)s, so --mode shows its real default and a '%' in the checkout path no longer breaks --help. - .gitignore describes what lands in /recordings/ instead of listing it; test_oak_camera's docstring says the MCAP goes under the current directory. Signed-off-by: Ivan Yang <yifanyang@nvidia.com> --------- Signed-off-by: Jiwen Cai <jiwenc@nvidia.com> Signed-off-by: Ivan Yang <yifanyang@nvidia.com> Co-authored-by: Jiwen Cai <jiwenc@nvidia.com>
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up to #1355, which added the GLFW packages to the shared source-build prerequisites and linked three setup pages to them. This finishes that sweep.
libvulkan-dev) and the CUDA toolkit are found. Without them the build leaves Televiz out silently and setup fails later at the import check.Type of change
Testing
make -C docs current-docs(sphinx-build -W) passes; checked the rendered link text on the edited pages.SKIP=check-copyright-year pre-commit run --all-filespasses.Checklist
SKIP=check-copyright-year pre-commit run --all-filesgit commit -s) per the DCOSummary by CodeRabbit