Skip to content

Commit f83ac21

Browse files
committed
Reformat into subpage.
1 parent fee89c4 commit f83ac21

10 files changed

Lines changed: 35 additions & 20 deletions

File tree

docs/index.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -227,17 +227,12 @@ TABLE OF CONTENTS
227227
pages/concepts/concept_overview
228228
pages/concepts/concept_environment_design
229229
pages/concepts/scene/index
230-
pages/concepts/embodiment/concept_embodiment_design
231-
pages/concepts/embodiment/concept_teleop_devices_design
232-
pages/concepts/task/concept_tasks_design
233-
pages/concepts/task/concept_metrics_design
230+
pages/concepts/embodiment/index
231+
pages/concepts/task/index
234232
pages/concepts/concept_environment_compilation
235233
pages/concepts/concept_policy_design
236234
pages/concepts/concept_remote_policies_design
237235

238-
.. pages/concepts/scene/concept_scene_design
239-
.. pages/concepts/scene/concept_assets_design
240-
.. pages/concepts/scene/concept_affordances_design
241236

242237

243238
.. toctree::

docs/pages/concepts/concept_overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ to building a library of environment *parts*.
4747
In this section of the documentation, we will describe the design of each of these sub-pieces:
4848
Scene, Embodiment, and Task.
4949

50-
* :doc:`scene/concept_scene_design`
50+
* :doc:`scene/index`
5151

5252
.. In the core of the workflow, we have three main components, **Scene**, **Embodiment**, and **Task**. We compile most of the managers of the
5353
.. manager-based RL environment from these three components. We strongly incline towards keeping these components as independent as possible. This

docs/pages/concepts/embodiment/concept_embodiment_design.rst renamed to docs/pages/concepts/embodiment/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,3 +170,13 @@ Usage Examples
170170
scene=scene,
171171
task=task
172172
)
173+
174+
More details
175+
------------
176+
177+
The rest of this section will describe further details of the embodiment component.
178+
179+
.. toctree::
180+
:maxdepth: 1
181+
182+
concept_teleop_devices_design

docs/pages/concepts/scene/concept_assets_design.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Assets Design
22
=============
33

4-
Task me back to :doc:`index`
4+
Take me back to :doc:`index`
55

66
Assets are the building blocks of simulation environments - robots, objects, backgrounds, and scene elements.
77
The asset system provides a registry system for managing these components.

docs/pages/concepts/task/concept_tasks_design.rst renamed to docs/pages/concepts/task/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,13 @@ The order of the tasks in the list determines the order in which subtasks must b
131131
**Available Examples**
132132

133133
- **PutAndCloseDoorTask**: Pick up and move an object to a destination location and then close a door (within **GR1PutAndCloseDoorEnvironment**).
134+
135+
More details
136+
------------
137+
138+
The rest of this section will describe further details of the task component.
139+
140+
.. toctree::
141+
:maxdepth: 1
142+
143+
concept_metrics_design

docs/pages/example_workflows/locomanipulation/step_1_environment_setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ currently set manually to create an achievable task.
116116
scene = Scene(assets=[background, pick_up_object, blue_sorting_bin])
117117
118118
Now we bring everything together into a IsaacLab-Arena scene.
119-
See :doc:`../../concepts/scene/concept_scene_design` for scene composition details.
119+
See :doc:`../../concepts/scene/index` for scene composition details.
120120

121121
**4. Create the Locomanip Pick and Place Task**
122122

@@ -129,7 +129,7 @@ environment: pick up the specified object and place it in the blue sorting bin.
129129

130130
The task knows about the key objects involved (what to pick, where to place it, and the environment context) and will
131131
provide rewards, compute observations, and determine when the episode should end.
132-
See :doc:`../../concepts/task/concept_tasks_design` for task creation details.
132+
See :doc:`../../concepts/task/index` for task creation details.
133133

134134
**5. Create the IsaacLab Arena Environment**
135135

docs/pages/example_workflows/reinforcement_learning/step_1_environment_setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ is positioned below to provide physical support.
109109
scene = Scene(assets=assets)
110110
111111
Now we bring everything together into an IsaacLab-Arena scene.
112-
See :doc:`../../concepts/scene/concept_scene_design` for scene composition details.
112+
See :doc:`../../concepts/scene/index` for scene composition details.
113113

114114
**4. Create the Lift Object RL Task**
115115

@@ -133,7 +133,7 @@ The task includes:
133133
- **Termination Conditions**: Object dropped or timeout
134134
- **Success Condition**: Object reaches target position (disabled by the ``--rl_training_mode`` flag for training)
135135

136-
See :doc:`../../concepts/task/concept_tasks_design` for task creation details.
136+
See :doc:`../../concepts/task/index` for task creation details.
137137

138138
**5. Create the IsaacLab Arena Environment**
139139

docs/pages/example_workflows/sequential_static_manipulation/step_1_environment_setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ the relational object placement APIs. The object is placed within a randomzation
321321
sequential_task = PutAndCloseDoorTask(subtasks=[pick_and_place_task, close_door_task])
322322
323323
The sequential task is composed of two atomic subtasks: the pick and place task and the close door task.
324-
See :doc:`../../concepts/task/concept_tasks_design` for task creation details.
324+
See :doc:`../../concepts/task/index` for task creation details.
325325

326326

327327
**4. Compose the Scene**
@@ -331,7 +331,7 @@ See :doc:`../../concepts/task/concept_tasks_design` for task creation details.
331331
scene = Scene(assets=[kitchen_background, pickup_object, light, refrigerator, refrigerator_shelf])
332332
333333
Now we bring everything together into an IsaacLab-Arena scene.
334-
See :doc:`../../concepts/scene/concept_scene_design` for scene composition details.
334+
See :doc:`../../concepts/scene/index` for scene composition details.
335335

336336

337337
**5. Create the IsaacLab Arena Environment**

docs/pages/example_workflows/static_manipulation/step_1_environment_setup.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ currently set manually to create an achievable task. In this case, we place the
100100
scene = Scene(assets=assets)
101101
102102
Now we bring everything together into an IsaacLab-Arena scene.
103-
See :doc:`../../concepts/scene/concept_scene_design` for scene composition details.
103+
See :doc:`../../concepts/scene/index` for scene composition details.
104104

105105
**4. Create the Open Door Task**
106106

@@ -109,7 +109,7 @@ See :doc:`../../concepts/scene/concept_scene_design` for scene composition detai
109109
task = OpenDoorTask(microwave, openness_threshold=0.8, reset_openness=0.2)
110110
111111
The ``OpenDoorTask`` encapsulates the goal of this environment: open the microwave door.
112-
See :doc:`../../concepts/task/concept_tasks_design` for task creation details.
112+
See :doc:`../../concepts/task/index` for task creation details.
113113

114114
**5. Create the IsaacLab Arena Environment**
115115

docs/pages/quickstart/first_arena_env.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ space, observation space, and cameras. ``droid_abs_joint_pos`` is the DROID setu
176176
Robotiq 2F-85 gripper) with absolute joint-position control.
177177

178178
Swapping ``--embodiment`` replaces the robot entirely — observations, actions, and sensors update
179-
automatically. See :doc:`../concepts/embodiment/concept_embodiment_design` for details.
179+
automatically. See :doc:`../concepts/embodiment/index` for details.
180180

181181

182182
Step 5: Compose the Scene
@@ -190,7 +190,7 @@ The ``Scene`` collects all physical assets. The embodiment is kept separate —
190190
to ``IsaacLabArenaEnvironment`` rather than added to the scene — because the robot interacts with
191191
the scene rather than being part of it.
192192

193-
See :doc:`../concepts/scene/concept_scene_design` for scene composition details.
193+
See :doc:`../concepts/scene/index` for scene composition details.
194194

195195

196196
Step 6: Define the Task
@@ -214,7 +214,7 @@ It also attaches metrics (``SuccessRateMetric``, ``ObjectMovedRateMetric``) that
214214
collects at the end of each episode. These metrics will report the proportion of successful episodes,
215215
as well as the proportion of episodes in which the object was moved.
216216

217-
See :doc:`../concepts/task/concept_tasks_design` for creating custom tasks.
217+
See :doc:`../concepts/task/index` for creating custom tasks.
218218

219219

220220
Step 7: Assemble the Environment

0 commit comments

Comments
 (0)