Fix leapp docs#5512
Conversation
Greptile SummaryThis PR corrects the
Confidence Score: 5/5Safe to merge — a one-line documentation-only fix with no runtime impact. The change updates three line-range values in an RST emphasize-lines directive. Cross-checking against the actual Python file confirms the new ranges correctly land on the LEAPP import (line 20), the output-annotation block (lines 75-77), and the input-annotation block (lines 92-105). No logic, configuration, or API surface is touched. No files require special attention. Important Files Changed
Reviews (1): Last reviewed commit: "fix docs highlight misalignment" | Re-trigger Greptile |
There was a problem hiding this comment.
Review: PR #5512 — fix docs highlight misalignment
LGTM! Clean docs fix.
Changes reviewed:
- Corrects the install command to use
./isaaclab.sh -p -m pip install leapp(proper Isaac Lab Python env) instead of barepip install leapp. - Expands the tutorial intro with clearer setup steps (install LEAPP, copy tutorial file into task package).
- Fixes the
:emphasize-lines:directive from20, 100-118, 85-88→20, 75-77, 92-105to match actual source line numbers — this was the highlight misalignment. - Minor wording fix in the warning block.
No issues found. Ship it. 🚀
Update (9d77b02): Reviewed the rebased commits. No content changes from the previous review — same documentation improvements, now rebased on develop. ✅
fc8e713 to
9d77b02
Compare
…5637) # Description Restructures the physics-backend documentation to give each backend a first-class home and to add the cross-backend orientation pages asked for in [isaac-sim/IsaacLab-Internal#876](isaac-sim/IsaacLab-Internal#876). **Structure** ``` docs/source/overview/core-concepts/physical-backends/ ├── index.rst ← user-facing hub + feature-support matrix ├── solver-comparison.rst ← cross-backend behavioural differences ├── physx/ │ ├── index.rst │ ├── installation.rst │ ├── configuration.rst ← PhysxCfg tuning knobs │ └── supported-features.rst ├── newton/ │ ├── index.rst │ ├── installation.rst │ ├── supported-features.rst (was experimental-features/.../limitations-and-known-bugs.rst) │ ├── mjwarp-solver.rst (was experimental-features/.../solver-transitioning.rst) │ └── kamino-solver.rst (was experimental-features/.../using-kamino.rst) └── ovphysx/ └── index.rst ← stub flagged as highly experimental; tracking issue #5634 ``` **Highlights** - The Newton subdir moves wholesale out of `experimental-features/` via `git mv`; framing changes from "experimental feature branch" to "beta backend." The Experimental Features toctree now contains only `bleeding-edge`. - Per-solver Newton pages (`mjwarp-solver`, `kamino-solver`) replace the old `solver-transitioning` / `using-kamino` files, matching #876's "sub-sections for the Newton solvers" ask. - New PhysX page set written from `isaaclab_physx.physics.PhysxCfg`, mirroring the Newton structure. - OvPhysX stub references the full in-flight PR set (#5421, #5422, #5426, #5459, #5570, #5589) and is gated by a follow-up issue (#5634) for expansion after those land. - `solver-comparison.rst` covers friction, contact pipeline, restitution, stabilization, convergence, articulation coordinates, substepping, and GPU buffers across PhysX TGS, Newton MJWarp, and Newton Kamino. Each cell points at the concrete config attribute that controls the behavior, with a porting checklist at the end. - Newton's `supported-features.rst` list refreshed against `develop`'s actual `newton_mjwarp` coverage (adds Shadow Hand, Shadow Hand Over, cabinet, dexsuite, rough-terrain locomotion). Replaces the bit-rotting bullet list with a discovery recipe (`grep -rln newton_mjwarp source/isaaclab_tasks/`). - Cross-references updated in `docs/index.rst`, `core-concepts/index.rst`, `multi_backend_architecture.rst`, `features/visualization.rst`, and `overview/reinforcement-learning/rl_existing_scripts.rst`. Fixes isaac-sim/IsaacLab-Internal#876 ## Type of change - Documentation update ## Screenshots N/A — docs-only restructure. New page tree visible from the table-of-contents in `core-concepts/`. ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works *(N/A — docs-only)* - [ ] I have added a changelog fragment under `source/<pkg>/changelog.d/` for every touched package *(N/A — docs-only; matches precedent of #5512 and 4aeb4d6 which shipped without fragments)* - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Screenshots
Please attach before and after screenshots of the change if applicable.
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there