Fold deformable migration page into the 3.0 migration guide - #7448
Fold deformable migration page into the 3.0 migration guide#7448mmichelis wants to merge 1 commit into
Conversation
The deformable body API change is a one-time 2.x to 3.0 concern, so a dedicated 252-line child page under the migration guide is more surface than the topic needs. Most of it also duplicated content that is already maintained elsewhere: the added-property and material-property lists restate docstrings rendered by autodoc, the surface and USD-file code examples repeat scripts/demos/deformables.py verbatim, and the root_physx_view note repeats the guide's own asset-view section. The added-property list had already drifted, omitting settling_threshold, sleep_threshold, max_depenetration_velocity and the self-collision fields. Merge the content that cannot be recovered from source into the existing "Deformable Object API Changes" section and drop the child page: - Import changes, trimmed to three rows and using the short isaaclab_newton.sim paths for consistency with the PhysX rows. - Removed properties with their replacements, class-qualified since they span the properties cfg, the material cfg and the deleted PhysxDeformableCollisionPropertiesCfg. Autodoc cannot render a class that no longer exists, so this only survives in a migration note. - The volume-only kinematic target restriction, which is raised at runtime but absent from the method docstring. Replace the removed code examples with pointers to the deformable object tutorial and scripts/demos/deformables.py.
Greptile SummaryThe PR removes the standalone deformables migration page and folds its durable guidance into the Isaac Lab 3.0 migration guide.
Confidence Score: 4/5The documentation consolidation should not merge until the associated migration agent skill is updated to cover the newly incorporated deformable guidance. The guide explicitly requires same-change synchronization with its agent skill, but the skill still omits deformables and can therefore provide incomplete migration guidance for affected projects. Files Needing Attention: docs/source/migration/migrating_to_isaaclab_3-0.rst and skills/user/migrate-2x-to-3x/SKILL.md Important Files Changed
|
There was a problem hiding this comment.
Isaac Lab Review Bot
This documentation-only change consolidates the deformable 2.x-to-3.0 migration guidance into the main 3.0 guide and removes the former child page and its toctree entry. No candidate findings were supplied or supported for acceptance.
- Design and architecture: Keeping this one-time migration material in the existing "Deformable Object API Changes" section is coherent and reduces duplicated documentation. The child page and its toctree integration are removed together; the known tradeoff is that the former published page URL has no redirect mechanism and will return 404.
- API: No source API is changed. The consolidated guide retains the backend-specific import paths, removed-property replacements, view-property deprecation, and surface-versus-volume behavior distinctions. The shortened Newton class references are the relevant documentation-resolution surface, and the reported successful Sphinx build indicates they resolve without introducing warnings.
- Implementation: The changed documentation preserves the principal migration paths for deformable properties, materials, collision offsets, kinematic targets, and root views while replacing duplicated examples with maintained tutorial and demo references. The patch also removes the obsolete toctree entry, avoiding a dangling document inclusion.
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.
Description
docs/source/migration/migrating_deformables.rstwas a 252-line child page hanging off the 3.0 migration guide, which already carried a ~20-line "Deformable Object API Changes" summary whose only job was to link out to it. The deformable body API change is a one-time 2.x to 3.0 concern, so it does not warrant a dedicated page, and most of the page's content was duplicated from sources that are already maintained elsewhere:schemas_cfg.pyandphysics_materials_cfg.py. The added-property list had in fact already drifted from source, omittingsettling_threshold,sleep_threshold,max_depenetration_velocity,self_collisionandself_collision_filter_distance.scripts/demos/deformables.pyverbatim, and the volume example repeats the deformable object tutorial.root_physx_viewtoroot_viewsection repeats the migration guide's own asset-view section.This PR folds the content that cannot be recovered from source into the existing "Deformable Object API Changes" section and deletes the child page. Net change is 252 lines removed against 81 added.
What was kept:
isaaclab_newton.simpaths so the Newton rows are consistent with the PhysX rows. Both packages use the samelazy_exportmachinery, so the deeper submodule paths the old page used were unnecessary.PhysxDeformableBodyPropertiesCfg,PhysxDeformableBodyMaterialCfgand the deletedPhysxDeformableCollisionPropertiesCfg. Autodoc can never render a class that no longer exists, so a migration note is the only place this can live.deformable_object.pybut has noRaises:entry in the method docstring, so the migration guide is currently the only documentation of it.Code examples were replaced with pointers to the deformable object tutorial and
scripts/demos/deformables.py, both of which are runnable and cover the volume, surface and USD-asset cases.Type of change
Release backport
developChecklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (do not editCHANGELOG.rstor bumpextension.toml— CI handles that)CONTRIBUTORS.mdor my name already exists thereNotes on the two unchecked items: this is a docs-only change with no source package touched, so there is nothing to test and no package needs a changelog fragment.
Verification: a full Sphinx build succeeds with 15 warnings, the same count as before the change, and all 15 are pre-existing
duplicate object descriptionautodoc warnings unrelated to this PR../isaaclab.sh --formatpasses, including the RST hooks and the changelog fragment check. No references to the deleted page remain anywhere in the repository.