Fix LEAPP documentation references and quick start - #7545
Conversation
There was a problem hiding this comment.
Isaac Lab Review Bot
The documentation update retargets LEAPP deployment environment references to the public isaaclab.envs namespace and makes the quick-start export and deployment commands consistently use Newton MJWarp with NewtonGL.
- Design and architecture: Using the public
isaaclab.envsnamespace keeps the documented class path aligned with the intended user-facing API rather than exposing its implementation module. The deployment guide’s newisaaclabmodule context is consistent with its relativeenvs.LeappDeploymentEnvreference. - API: No Python API or CLI contract is changed. The documented
physics=newton_mjwarpand--viz newton_glselectors align the quick start with the existing Newton deployment example and itsleapp-only prerequisite. - Implementation: The two Sphinx reference forms and the quick-start producer/deployment commands were traced across the changed pages and are internally consistent. The remaining validation risk is whether the public export resolves during the pending warning-as-error documentation build.
No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.
Automated review; human maintainers own approval decisions.
Greptile SummaryThe PR updates LEAPP API references and changes the quick start to use Newton MJWarp with NewtonGL.
Confidence Score: 4/5The PR should not merge until Both changed class references resolve to Files Needing Attention: docs/source/api/lab/isaaclab.envs.leapp_deployment_env.rst; docs/source/policy_deployment/05_leapp/deploying_exported_policies_with_leapp.rst Important Files Changed
Reviews (1): Last reviewed commit: "Fix LEAPP documentation references and q..." | Re-trigger Greptile |
|
run-ci |
Description
Fix two LEAPP documentation issues identified while reviewing #7541:
LeappDeploymentEnvfrom the publicisaaclab.envslazy-export stub, document it under that namespace, and add the missing module context to the deployment guide so its class references resolve.leapp-only prerequisites.Type of change
Release backport
developScreenshots
Not applicable.
Validation
LeappDeploymentEnvthrough both__all__anddir().sphinx-lintreported no problems for the changed documentation.Checklist
source/<pkg>/changelog.d/for every touched packageCONTRIBUTORS.mdor my name already exists there