-
Notifications
You must be signed in to change notification settings - Fork 2.6k
fixes the "Installing dependencies" section in pip install docs #3969
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
Fixed broken "Installing dependencies" section in the Isaac Lab pip installation documentation by removing duplicate content and correcting the installation order.
Key Changes:
- Removed duplicate PyTorch installation instructions (previously appeared twice)
- Removed duplicate Isaac Lab installation instructions
- Removed outdated Isaac Lab v2.2.0 installation, keeping only v2.3.0
- Reordered steps to follow logical sequence: PyTorch → Isaac Lab → rl_games
- Consolidated PyTorch description text to include architecture reference inline
- Added contributor name to
CONTRIBUTORS.md
The changes successfully address issue #3967 by cleaning up the documentation structure and providing a single, clear installation path for users.
Confidence Score: 5/5
- This PR is safe to merge with no risk
- The changes are purely documentation fixes that remove duplicate content and correct ordering. No code logic is affected, RST syntax is correct, and the contributor was properly added alphabetically. The fix directly addresses the reported issue with clear before/after screenshots provided.
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| CONTRIBUTORS.md | 5/5 | Added author name in alphabetical order |
| docs/source/setup/installation/isaaclab_pip_installation.rst | 5/5 | Removed duplicate content, corrected ordering of installation steps, and updated to use version 2.3.0 |
Sequence Diagram
sequenceDiagram
participant Author as PR Author
participant Docs as Documentation (RST)
participant Users as End Users
Author->>Docs: Identify duplicate content issue
Author->>Docs: Remove duplicate PyTorch installation
Author->>Docs: Remove duplicate Isaac Lab install (v2.2.0)
Author->>Docs: Reorder steps (PyTorch first, then Isaac Lab)
Author->>Docs: Consolidate PyTorch description text
Author->>Docs: Keep only Isaac Lab v2.3.0
Docs->>Users: Provide clearer installation instructions
Docs->>Users: Avoid confusion from duplicates
Users->>Docs: Follow streamlined installation process
2 files reviewed, no comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
This PR fixes documentation issues in the pip installation guide by removing duplicate content and correcting the installation order. The changes eliminate redundant PyTorch installation instructions, remove the outdated Isaac Lab 2.2.0 installation command (keeping only 2.3.0), and reorder steps logically (PyTorch → Isaac Lab → rl_games). The PR also adds the contributor's name to CONTRIBUTORS.md in alphabetical order.
Confidence Score: 5/5
- This PR is safe to merge with no risk
- Documentation-only changes that fix clear formatting issues with no code impact. The changes correctly remove duplicates, fix ordering, and update to the current version (2.3.0)
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/source/setup/installation/isaaclab_pip_installation.rst | 5/5 | Removed duplicate installation instructions, outdated version references, and fixed ordering in the "Installing dependencies" section |
| CONTRIBUTORS.md | 5/5 | Added contributor name in correct alphabetical order |
Sequence Diagram
sequenceDiagram
participant User
participant Docs as Documentation Site
participant File as isaaclab_pip_installation.rst
User->>Docs: Navigate to pip installation guide
Docs->>File: Render Installing dependencies section
Note over File: Before PR had duplicate content
Note over File: 2 PyTorch install methods
Note over File: 2 Isaac Lab versions (2.2.0 and 2.3.0)
Note over File: 2 UV pip notes
Note over File: Wrong order (rl_games before Isaac Lab)
File->>User: Show confusing duplicated instructions
Note over File: After PR has clean content
Note over File: 1 PyTorch install (tabbed for platforms)
Note over File: 1 Isaac Lab version (2.3.0 only)
Note over File: 1 UV pip note
Note over File: Correct order (PyTorch then Isaac Lab then rl_games)
File->>User: Show clear organized instructions
2 files reviewed, no comments
Description
In the Local Installation / Installation using Isaac Lab Pip Packages page of the documentation, the “Installing dependencies” section is broken. I removed duplicate content and corrected the ordering.
Fixes #3967
Type of change
Screenshots
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there