Fix docs

kellyguo11 · Oct 24, 2024 · a7ffb6f · a7ffb6f
1 parent 80635a6
commit a7ffb6f
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -98,7 +98,6 @@ Table of Contents
    source/features/multi_gpu
    source/features/tiled_rendering
    source/features/reproducibility
-   .. source/features/motion_generators
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/api/lab/omni.isaac.lab.sim.rst b/docs/source/api/lab/omni.isaac.lab.sim.rst
@@ -19,6 +19,7 @@
     SimulationContext
     SimulationCfg
     PhysxCfg
+    RenderCfg
 
   .. rubric:: Functions
 
@@ -46,6 +47,11 @@ Simulation Configuration
   :show-inheritance:
   :exclude-members: __init__
 
+.. autoclass:: RenderCfg
+  :members:
+  :show-inheritance:
+  :exclude-members: __init__
+
 Simulation Context Builder
 --------------------------
 

diff --git a/docs/source/features/hydra.rst b/docs/source/features/hydra.rst
@@ -89,8 +89,8 @@ Elements in dictionaries are handled as a parameters in the hierarchy. For examp
 
 .. literalinclude:: ../../../source/extensions/omni.isaac.lab_tasks/omni/isaac/lab_tasks/manager_based/classic/cartpole/cartpole_env_cfg.py
     :language: python
-    :lines: 99-111
-    :emphasize-lines: 10
+    :lines: 90-114
+    :emphasize-lines: 11
 
 the ``position_range`` parameter can be modified with ``env.events.reset_cart_position.params.position_range="[-2.0, 2.0]"``.
 This example shows two noteworthy points:
@@ -112,7 +112,7 @@ For example, for the configuration of the Cartpole camera depth environment:
     :language: python
     :start-at: class CartpoleDepthCameraEnvCfg
     :end-at: tiled_camera.width
-    :emphasize-lines: 16
+    :emphasize-lines: 10, 15
 
 If the user were to modify the width of the camera, i.e. ``env.tiled_camera.width=128``, then the parameter
 ``env.observation_space=[80,128,1]`` must be updated and given as input as well.

diff --git a/docs/source/overview/core-concepts/index.rst b/docs/source/overview/core-concepts/index.rst
@@ -9,3 +9,5 @@ This section we introduce core concepts in Isaac Lab.
 
   task_workflows
   actuators
+
+# motion_generators
diff --git a/source/extensions/omni.isaac.lab/docs/CHANGELOG.rst b/source/extensions/omni.isaac.lab/docs/CHANGELOG.rst
@@ -7,7 +7,8 @@ Changelog
 Added
 ^^^^^
 
-* Added :class:`RenderCfg` in :class:`SimulationCfg for specifying render related settings.
+* Added :class:`~omni.isaac.lab.sim.RenderCfg` and the attribute :attr:`~omni.isaac.lab.sim.SimulationCfg.render` for
+  specifying render related settings.
 
 
 0.27.0 (2024-10-14)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,5 @@ This section we introduce core concepts in Isaac Lab.

		task_workflows
		actuators

		# motion_generators