SuperAPI AI 工具集

isaaclab-updating-environment-docs

编程与开发

查看项目

更新于 11-10 06:25

技能介绍

用途

该技能用于在 Isaac Lab 中新增或重命名已注册环境,或其接受的 physics=、renderer=、presets= 选择器发生变化时,保持自动生成的环境浏览器与任务注册信息、预设选择器同步。

主要能力与工作流程

  1. 读取任务注册与配置,识别训练 ID、推理 ID、工作流、强化学习库入口点及可选预设。核心任务使用无版本号的 Isaac- ID,贡献任务使用无版本号的 IsaacContrib- ID;如需重命名,将已发布 ID 保留为弃用别名。
  2. 区分可选预设与固定配置:若任务仅支持一个硬编码后端,则留空其 Presets 单元格,而不是添加或记录单选项选择器。
  3. 新世界需在 docs/source/_static/environment-previews/ 下添加代表性截图,并在运行更新器前将其分配到 docs/source/_static/css/environment-browser.js 中任务对应的生成行。截图应使用 Kit 可视化器捕获,以与现有预览渲染一致,除非任务有意记录其他可视化器。
  4. 运行基于注册表的更新器:
uv run python tools/update_environments_rst.py

该命令会从 Gym 注册表重写环境浏览器任务行,并按 physics=、renderer=、presets= 分组名称,同时保留已有的预览图片分配。

  1. 审查生成的差异。不要手动编辑环境浏览器标记注释之间的选择器数据。
  2. 确认环境浏览器包含该任务且与任务接受的选择器一致。
  3. 遵循贡献指南的文档验证要求:编辑时使用增量 HTML 预览,发布 PR 前要求最终文档更新有一次干净、无警告的构建。

验证

运行:

uv run python tools/update_environments_rst.py --check
uv run python scripts/environments/list_envs.py --show_presets
uv run --no-project python tools/skills/cli.py check

按需运行指南的 HTML 预览或最终干净构建,使用 dev extra 获取 Sphinx 依赖。要求检查与最终文档构建成功退出且无警告或错误。在文档构建输出中检查编译后的环境浏览器,验证每个新图片和任务选择器正确渲染。

维护

保持此工作流与环境浏览器标记、注册表收集器、预设 CLI 及环境列表脚本同步。当这些工具变化时,先更新源文档行为,并保持此技能为简洁的路由检查清单。

限制

未提供关于该技能支持的操作系统、Isaac Lab 具体版本或额外依赖的说明。