Skip to content

Fix LEAPP documentation references and quick start - #7545

Open
kellyguo11 wants to merge 2 commits into
isaac-sim:developfrom
kellyguo11:codex/fix-leapp-doc-links-quickstart
Open

Fix LEAPP documentation references and quick start#7545
kellyguo11 wants to merge 2 commits into
isaac-sim:developfrom
kellyguo11:codex/fix-leapp-doc-links-quickstart

Conversation

@kellyguo11

@kellyguo11 kellyguo11 commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Description

Fix two LEAPP documentation issues identified while reviewing #7541:

  • Expose LeappDeploymentEnv from the public isaaclab.envs lazy-export stub, document it under that namespace, and add the missing module context to the deployment guide so its class references resolve.
  • Make the quick-start export and deployment commands consistently use Newton MJWarp with the NewtonGL visualizer, matching the documented leapp-only prerequisites.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Release backport

  • Backport this pull request to the active release branch after it merges into develop

Screenshots

Not applicable.

Validation

  • Verified the lazy-export stub exposes LeappDeploymentEnv through both __all__ and dir().
  • Focused pre-commit checks passed for all changed files, including the changelog and Git LFS gates.
  • sphinx-lint reported no problems for the changed documentation.
  • The full warning-as-error documentation build is pending Linux CI because the repository lockfile does not support the local macOS/arm64 platform.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the applicable pre-commit checks
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings (full build pending Linux CI)
  • I have added tests that prove my fix is effective or that my feature works (covered by focused lazy-export contract validation)
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@kellyguo11
kellyguo11 requested a review from a team September 3, 2026 20:34
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Sep 3, 2026

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.envs namespace keeps the documented class path aligned with the intended user-facing API rather than exposing its implementation module. The deployment guide’s new isaaclab module context is consistent with its relative envs.LeappDeploymentEnv reference.
  • API: No Python API or CLI contract is changed. The documented physics=newton_mjwarp and --viz newton_gl selectors align the quick start with the existing Newton deployment example and its leapp-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-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR updates LEAPP API references and changes the quick start to use Newton MJWarp with NewtonGL.

  • Moves LeappDeploymentEnv documentation references toward the intended public namespace.
  • Adds module context to the deployment guide.
  • Aligns export and deployment commands on the Newton MJWarp backend and NewtonGL visualizer.

Confidence Score: 4/5

The PR should not merge until LeappDeploymentEnv is actually exported from isaaclab.envs or the documentation references its defining module.

Both changed class references resolve to isaaclab.envs.LeappDeploymentEnv, but the lazy-export stub does not expose that symbol, leaving the intended Sphinx references unresolved.

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

Filename Overview
docs/source/api/lab/isaaclab.envs.leapp_deployment_env.rst Changes autoclass resolution to a package namespace that does not currently export LeappDeploymentEnv.
docs/source/policy_deployment/05_leapp/deploying_exported_policies_with_leapp.rst Adds module context, but the resulting class target resolves through the same absent package-level export.
docs/source/policy_deployment/05_leapp/exporting_policies_with_leapp.rst Consistently documents supported Newton MJWarp and NewtonGL command arguments.

Reviews (1): Last reviewed commit: "Fix LEAPP documentation references and q..." | Re-trigger Greptile

Comment thread docs/source/api/lab/isaaclab.envs.leapp_deployment_env.rst
@github-actions github-actions Bot added the isaac-lab Related to Isaac Lab team label Sep 3, 2026
@kellyguo11

Copy link
Copy Markdown
Contributor Author

run-ci

@isaaclab-bot isaaclab-bot Bot added ci:run-docker Trigger the on-demand Docker and GPU CI workflow and removed ci:run-docker Trigger the on-demand Docker and GPU CI workflow labels Sep 3, 2026
@kellyguo11 kellyguo11 mentioned this pull request Sep 3, 2026
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants