Skip to content

[Task Clean-up][Docs] Regenerate the stale environment overview table#6410

Open
hujc7 wants to merge 1 commit into
isaac-sim:developfrom
hujc7:jichuanh/task-cleanup-docs-regen
Open

[Task Clean-up][Docs] Regenerate the stale environment overview table#6410
hujc7 wants to merge 1 commit into
isaac-sim:developfrom
hujc7:jichuanh/task-cleanup-docs-regen

Conversation

@hujc7

@hujc7 hujc7 commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Regenerates docs/source/overview/environments.rst with tools/update_environments_rst.py on current develop — the committed table had drifted (renderer preset renames and several registrations landed without regeneration).
  • Mechanical change, no hand edits; lets subsequent [Task Clean-up] PRs carry only their own table rows.

Dependencies

  • None.

The committed table has drifted from the output of
tools/update_environments_rst.py (renderer preset renames and several
registrations landed without regeneration). Regenerating on current
develop so subsequent task PRs carry only their own rows.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 8, 2026
@greptile-apps

greptile-apps Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR regenerates docs/source/overview/environments.rst by running tools/update_environments_rst.py against the current develop branch registry, bringing a stale committed table back in sync with the actual registered environments.

  • Removes environments that are no longer in the Gym registry (e.g. several IsaacContrib-AutoMate-*, IsaacContrib-Deploy-*, and IsaacContrib-Cartpole-Showcase-* entries), and adds newly registered ones (Isaac-DrLegs-*, Isaac-Fourbar-Pole-Swingup, Isaac-Lift-KukaAllegro, IsaacContrib-Stack-Cube-SO101-*, and others).
  • Fixes physics-preset listings to include ovphysx and newton_kamino where they were missing, and consolidates standalone Play-environment rows into the dedicated Eval column of their training counterpart (e.g. Isaac-Velocity-Flat-AnymalD-Play is now the eval entry of Isaac-Velocity-Flat-AnymalD rather than an independent row).
  • No hand-edits; all content is generated by the existing tooling.

Confidence Score: 5/5

  • Documentation-only change produced entirely by the existing generation script; no runtime code is modified.
  • The single changed file is a generated RST table. The update script reads the live Gym registry and rewrites only the fenced AUTO-GENERATED block, leaving all surrounding prose untouched. The structural improvements (consolidating Play rows into the Eval column, adding missing physics presets) are consistent with the script's output logic and the PR description's stated intent.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/source/overview/environments.rst Auto-generated table regenerated via tools/update_environments_rst.py: adds new environments, removes stale ones, fixes physics/renderer preset listings, and consolidates Play rows into the Eval column.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[tools/update_environments_rst.py] --> B[Bootstrap source/* packages onto sys.path]
    B --> C[Import isaaclab_tasks + isaaclab_tasks_experimental]
    C --> D[collect_environment_doc_rows\nReads Gym registry]
    D --> E[render_comprehensive_list_table\nBuilds RST list-table markup]
    E --> F[patch_environments_rst\nReplaces AUTO-GENERATED block]
    F --> G[docs/source/overview/environments.rst\nUpdated committed file]

    subgraph Changes in this PR
        H[Removed stale entries\nIsaacContrib-AutoMate, Deploy, Showcase…]
        I[Added new entries\nDrLegs, Fourbar, KukaAllegro, SO101…]
        J[Fixed physics presets\novphysx + newton_kamino additions]
        K[Consolidated Play rows\ninto Eval column]
    end

    G --> H & I & J & K
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[tools/update_environments_rst.py] --> B[Bootstrap source/* packages onto sys.path]
    B --> C[Import isaaclab_tasks + isaaclab_tasks_experimental]
    C --> D[collect_environment_doc_rows\nReads Gym registry]
    D --> E[render_comprehensive_list_table\nBuilds RST list-table markup]
    E --> F[patch_environments_rst\nReplaces AUTO-GENERATED block]
    F --> G[docs/source/overview/environments.rst\nUpdated committed file]

    subgraph Changes in this PR
        H[Removed stale entries\nIsaacContrib-AutoMate, Deploy, Showcase…]
        I[Added new entries\nDrLegs, Fourbar, KukaAllegro, SO101…]
        J[Fixed physics presets\novphysx + newton_kamino additions]
        K[Consolidated Play rows\ninto Eval column]
    end

    G --> H & I & J & K
Loading

Reviews (1): Last reviewed commit: "Regenerate the stale environment overvie..." | Re-trigger Greptile

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.

1 participant