Skip to content

Update OvPhysX backend docs#5812

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
AntoineRichard:antoiner/docs-ovphysx-backend-page
May 27, 2026
Merged

Update OvPhysX backend docs#5812
kellyguo11 merged 1 commit into
isaac-sim:developfrom
AntoineRichard:antoiner/docs-ovphysx-backend-page

Conversation

@AntoineRichard

Copy link
Copy Markdown
Collaborator

Description

Refreshes the OvPhysX physical backend documentation so it no longer presents merged work as open and gives users a minimal path to install and verify the backend.

  • Updates the OvPhysX status list for merged asset, sensor, SceneDataProvider, and FrameView work.
  • Adds minimal source-install notes for ov[ovphysx] / ov[all] and smoke-test commands.
  • Aligns the physical backend feature matrix with current OvPhysX coverage while keeping remaining work marked as in flight.

Addresses #5634

Type of change

  • Documentation update

Screenshots

Not applicable; this is a documentation text update.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings from the RST/pre-commit checks
  • Documentation-only change; no new tests were added
  • No changelog fragment is needed because this only touches top-level docs, not a package under source/<pkg>
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Test Plan

  • ./isaaclab.sh -f
  • ./isaaclab.sh -p -c "import ovphysx.types; from isaaclab_ovphysx.physics import OvPhysxCfg; print('OvPhysX runtime OK')"
  • ./isaaclab.sh -p -m pytest source/isaaclab_ovphysx/test/assets/test_rigid_object.py::test_initialization -k cpu

Full Sphinx build was not run locally because the Isaac Sim Python environment in this checkout does not have the sphinx module installed.

Refresh the OvPhysX backend page so it no longer lists merged pull requests as open. Add the runtime installation selector, a simple import check, and a smoke-test command so users can verify the backend setup.

Align the physical backend feature matrix with the merged OvPhysX coverage while keeping remaining experimental work marked as in flight.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 27, 2026
@greptile-apps

greptile-apps Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR refreshes the OvPhysX documentation to accurately reflect the current state of the backend: several previously in-flight integrations (Articulation, RigidObjectCollection, Contact Sensor, SceneDataProvider, FrameView) are now marked as merged, and the former stub page gains a practical Installation section and smoke-test commands.

  • Feature matrix (index.rst): Articulation API, Contact Sensor, and Rigid Object Collection API are promoted to "Yes" for OvPhysX; IMU and the Frame Transformer/sensor group move from "Not yet" to "In-flight".
  • OvPhysX detail page (ovphysx/index.rst): Replaces placeholder text with merged-PR references, a verified install path, import smoke-test, pytest smoke-test, and a headless zero-agent rollout command using standard Hydra preset syntax.

Confidence Score: 5/5

Documentation-only change with no code modifications; safe to merge.

All install commands were cross-checked against the CLI implementation and are correct. The feature matrix and the per-backend detail page are mutually consistent. No code paths are affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/overview/core-concepts/physical-backends/index.rst Feature support matrix updated: Articulation API, Contact Sensor, and Rigid Object Collection API now marked Yes for OvPhysX; IMU and Frame Transformer group promoted from Not yet to In-flight.
docs/source/overview/core-concepts/physical-backends/ovphysx/index.rst Stub page replaced with substantive content including merged-PR references, Installation and Testing sections with commands verified correct against the CLI implementation.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User: source install] --> B["./isaaclab.sh -i 'ov[ovphysx]'"]
    B --> C[isaaclab_ovphysx installed as editable]
    C --> D[Smoke test: import ovphysx.types]
    D -->|pass| E[pytest test_rigid_object.py -k cpu]
    E -->|pass| F["zero_agent.py presets=ovphysx"]
    F -->|pass| G[OvPhysX verified OK]
    D -->|fail| H[Re-run install step]
Loading

Reviews (1): Last reviewed commit: "Update OvPhysX backend docs" | Re-trigger Greptile

@kellyguo11 kellyguo11 merged commit 411f93a into isaac-sim:develop May 27, 2026
37 checks passed
kellyguo11 added a commit that referenced this pull request May 28, 2026
… locomanip quaternion, deformable demo, IK, benchmark scripts (#5816)

# Description

Cherry pick following PRs from develop:

- #5779 
- #5760
- #5791
- #5810 
- #5811
- #5812 
- #5754 
- #5802 
- #5803 
- #5782
- #5804 
- #5744 
- #5775 
- #5784

---------

Signed-off-by: Kelly Guo <kellyg@nvidia.com>
Co-authored-by: John <jaybdub@users.noreply.github.com>
Co-authored-by: myurasov-nv <168484206+myurasov-nv@users.noreply.github.com>
Co-authored-by: Antoine RICHARD <antoiner@nvidia.com>
Co-authored-by: Mike Yan Michelis <46975745+mmichelis@users.noreply.github.com>
Co-authored-by: hujc <jichuanh@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants