[Docs Overhaul] --extra usage explained, and fixes to commands - #6979
Conversation
Signed-off-by: Mustafa H <34825877+StafaH@users.noreply.github.com>
Greptile SummaryThe PR clarifies how to select optional dependencies with
Confidence Score: 5/5The documentation-only PR appears safe to merge with no actionable defects identified. The changed commands, extra names, compatibility guidance, and Sphinx references align with the checked project configuration and documentation structure. Important Files Changed
Reviews (1): Last reviewed commit: "Add more detail to install docs for -ext..." | Re-trigger Greptile |
There was a problem hiding this comment.
Isaac Lab Review Bot
The documentation usefully centralizes uv run --extra guidance and links the quickstart to a shared extras reference, but two inconsistencies need correction: rl-games is presented as an installable package extra despite the page stating it is not included in wheel extras, and the expanded backend table leaves several rows without the required third cell.
- Design and architecture: Centralizing optional-extra documentation under the new
installation-optional-extrastarget is a sound way to avoid duplicated guidance, and the new cross-references use that structure consistently. The shared section must clearly distinguish source-project extras from published wheel extras. - API: The documented placement of
uv run --extra, supported selector forms, and alignment of--extra ovphysxwithphysics=ovphysxare consistent. However, listingrl-gamesalongside extras installed throughuv pip install "isaaclab[<extra>]"oruv addcontradicts the existing statement thatrl_gamesis not included in wheel extras and requires separate installation. - Implementation: The visualizer table was fully converted to three columns, but the backend table adds a
Required extracolumn without adding a third cell to the Isaac Sim PhysX and renderer rows. The list-table therefore has inconsistent row widths and must be completed so docutils can render it.
Minor fixes needed. Posted 2 actionable findings inline.
Automated review; human maintainers own approval decisions.
| - Both OV backends: OV PhysX and OV RTX. | ||
| * - ``ovphysx`` / ``ovrtx`` | ||
| - OV PhysX only / OV RTX only. | ||
| * - ``rl-games`` / ``sb3`` / ``skrl`` / ``rsl-rl`` |
There was a problem hiding this comment.
🟡 Warning · Implementation — rl-games listed as unavailable wheel extra
This section tells users to install extras via uv pip install "isaaclab[<extra>]" / uv add, yet the same page states a few lines below that "The rl_games package is not included in wheel extras; install it separately when required". Listing rl-games here sends readers to an install command that will not provide the framework. Remove it, or explicitly separate source-project uv run extras from published wheel extras.
bab4bc9 to
4f23a07
Compare
Merging develop kept this branch's [tool.uv].conflicts block, which "[Docs Overhaul] --extra usage explained, and fixes to commands" (isaac-sim#6979) had deleted. The merge was textually clean but reverted that decision: ``uv sync --extra isaacsim --extra ov`` failed on this branch while it succeeds on develop, and the merged comment above ``all`` claimed no extra was forked while four were. Keep only the two pairs this branch needs. Isaac Sim and the OV backends resolve together again, and the contract test that guarded the empty table now asserts the single remaining fork instead.
Description
Adds a section for explain --extra usage for uv run, and links it to the install and preset.
Checklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (do not editCHANGELOG.rstor bumpextension.toml— CI handles that)CONTRIBUTORS.mdor my name already exists there