Skip to content

Add a current URDF loading guide to the Habitat-Sim docs - #2644

Closed
yurekami wants to merge 1 commit into
facebookresearch:mainfrom
yurekami:docs/urdf-loading-guide
Closed

Add a current URDF loading guide to the Habitat-Sim docs#2644
yurekami wants to merge 1 commit into
facebookresearch:mainfrom
yurekami:docs/urdf-loading-guide

Conversation

@yurekami

@yurekami yurekami commented Sep 1, 2026

Copy link
Copy Markdown

Summary

  • add a dedicated docs page for loading URDF articulated objects in current Habitat-Sim
  • document both direct Python import and the interactive viewer workflow
  • link the page from the docs index and navbar so the feature is discoverable

Why

Issue #1919 remains open because URDF import is supported in code, but the maintained docs do not provide a straightforward guide for loading a URDF in current Habitat-Sim.

Verification

  • git diff --check
  • RST parse with repo-specific role stubs: zero system messages
  • structural validation confirming the page is registered in docs inputs, nav, and index
  • API and example references checked against examples/viewer.py and tests/test_physics.py

A full docs build requires the Bullet-enabled Habitat-Sim install used by repository CI.

Closes #1919

Issue facebookresearch#1919 is still open because URDF import works in code but not as a discoverable user-facing guide. This adds one focused docs page tied to the current viewer and physics tests, then wires it into the published docs navigation so users can find the maintained entry points without digging through source files.

Constraint: Full docs build in CI depends on a Bullet-enabled habitat_sim install that is not present in this workspace
Rejected: Add a brand new tutorial script | broader diff than needed to close the documentation gap
Rejected: Update only attributesJSON | still leaves the direct runtime loading path hard to discover
Confidence: high
Scope-risk: narrow
Directive: Keep this page aligned with tests/test_physics.py and examples/viewer.py when URDF loading APIs or viewer shortcuts change
Tested: git diff --check; repo-local structural validation of docs wiring and referenced assets
@meta-cla meta-cla Bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Sep 1, 2026
@yurekami yurekami closed this Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Do not delete this pull request or issue due to inactivity.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

is loading of a URDF file possible

1 participant