Skip to content

Commit 92724dd

Browse files
kellyguo11kellyguo11
committed
docs: Document exported public API classes
Add API reference entries for exported classes that were missing from the documentation. Create indexed pages for specialized modules and correct docstrings that prevented warning-free Sphinx rendering.
1 parent 8781c2d commit 92724dd

58 files changed

Lines changed: 1897 additions & 124 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/conf.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,8 @@ def _read_pinned_versions() -> dict:
268268
"pinocchio",
269269
"qpsolvers",
270270
"flatdict",
271+
"leapp",
272+
"ovrtx",
271273
"filelock",
272274
"IPython",
273275
"cv2",

‎docs/source/api/index.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,3 +241,27 @@ isaaclab_tasks_experimental extension
241241
The package ``isaaclab_tasks_experimental`` contains experimental task implementations
242242
under active development, not yet part of the stable task suite.
243243
For the list of available environments, please refer to the :ref:`environments`.
244+
245+
246+
Additional public API modules
247+
-----------------------------
248+
249+
The following public modules provide additional specialized APIs:
250+
251+
.. toctree::
252+
:maxdepth: 1
253+
254+
lab/isaaclab.benchmark.recorders
255+
lab/isaaclab.sensors.camera
256+
lab/isaaclab.sensors.ray_caster
257+
lab/isaaclab.ui.widgets
258+
lab/isaaclab.ui.xr_widgets
259+
lab/isaaclab.utils.leapp
260+
lab_experimental/isaaclab_experimental.envs.mdp.actions
261+
lab_newton/isaaclab_newton.envs.mdp
262+
lab_newton/isaaclab_newton.ik
263+
lab_newton/isaaclab_newton.sim.views
264+
lab_ovphysx/isaaclab_ovphysx.sensors
265+
lab_ovphysx/isaaclab_ovphysx.sensors.ray_caster
266+
lab_physx/isaaclab_physx.sim.views
267+
lab_ppisp/isaaclab_ppisp

‎docs/source/api/lab/isaaclab.app.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,22 @@ Simulation Launcher
126126

127127
.. _livestream: https://docs.isaacsim.omniverse.nvidia.com/latest/installation/manual_livestream_clients.html
128128
.. _`WebRTC Livestream`: https://docs.isaacsim.omniverse.nvidia.com/latest/installation/manual_livestream_clients.html#isaac-sim-short-webrtc-streaming-client
129+
130+
Additional Public Classes
131+
-------------------------
132+
133+
The following classes are part of the public :mod:`isaaclab.app` API.
134+
135+
.. currentmodule:: isaaclab.app
136+
137+
.. autosummary::
138+
:nosignatures:
139+
140+
LoadingScreen
141+
SettingsManager
142+
143+
.. autoclass:: LoadingScreen
144+
:show-inheritance:
145+
146+
.. autoclass:: SettingsManager
147+
:show-inheritance:

‎docs/source/api/lab/isaaclab.assets.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,30 @@ Articulation Ordering
202202
.. autofunction:: parse_articulation_ordering_convention
203203

204204
.. autofunction:: get_articulation_name_ordering
205+
206+
Additional Public Classes
207+
-------------------------
208+
209+
The following classes are part of the public :mod:`isaaclab.assets` API.
210+
211+
.. currentmodule:: isaaclab.assets
212+
213+
.. autosummary::
214+
:nosignatures:
215+
216+
BaseRigidObject
217+
BaseRigidObjectCollection
218+
BaseRigidObjectCollectionData
219+
BaseRigidObjectData
220+
221+
.. autoclass:: BaseRigidObject
222+
:show-inheritance:
223+
224+
.. autoclass:: BaseRigidObjectCollection
225+
:show-inheritance:
226+
227+
.. autoclass:: BaseRigidObjectCollectionData
228+
:show-inheritance:
229+
230+
.. autoclass:: BaseRigidObjectData
231+
:show-inheritance:

‎docs/source/api/lab/isaaclab.benchmark.recorders.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
isaaclab.benchmark.recorders
2+
============================
3+
4+
.. automodule:: isaaclab.benchmark.recorders
5+
6+
Classes
7+
-------
8+
9+
The following classes are part of the public :mod:`isaaclab.benchmark.recorders` API.
10+
11+
.. currentmodule:: isaaclab.benchmark.recorders
12+
13+
.. autosummary::
14+
:nosignatures:
15+
16+
CPUInfoRecorder
17+
GPUInfoRecorder
18+
MemoryInfoRecorder
19+
VersionInfoRecorder
20+
21+
.. autoclass:: CPUInfoRecorder
22+
:show-inheritance:
23+
24+
.. autoclass:: GPUInfoRecorder
25+
:show-inheritance:
26+
27+
.. autoclass:: MemoryInfoRecorder
28+
:show-inheritance:
29+
30+
.. autoclass:: VersionInfoRecorder
31+
:show-inheritance:

‎docs/source/api/lab/isaaclab.benchmark.rst‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,122 @@ Benchmark Framework
183183

184184
.. autoclass:: TrainingBundle
185185
:members:
186+
187+
Additional Public Classes
188+
-------------------------
189+
190+
The following classes are part of the public :mod:`isaaclab.benchmark` API.
191+
192+
.. currentmodule:: isaaclab.benchmark
193+
194+
.. autosummary::
195+
:nosignatures:
196+
197+
BooleanMeasurement
198+
CProfileFunction
199+
DictMeasurement
200+
DictMetadata
201+
EnvironmentStepTiming
202+
FloatMetadata
203+
GpuDeviceInfo
204+
Hardware
205+
IntMetadata
206+
Learning
207+
LearningCurve
208+
ListMeasurement
209+
MeanStd
210+
Measurement
211+
MetadataBase
212+
Resources
213+
RunConfig
214+
RunIdentity
215+
Runtime
216+
SingleMeasurement
217+
StartupConfig
218+
StartupPhase
219+
StartupTime
220+
StatisticalMeasurement
221+
StringMetadata
222+
TestPhase
223+
Versions
224+
225+
.. autoclass:: BooleanMeasurement
226+
:show-inheritance:
227+
228+
.. autoclass:: CProfileFunction
229+
:show-inheritance:
230+
231+
.. autoclass:: DictMeasurement
232+
:show-inheritance:
233+
234+
.. autoclass:: DictMetadata
235+
:show-inheritance:
236+
237+
.. autoclass:: EnvironmentStepTiming
238+
:show-inheritance:
239+
240+
.. autoclass:: FloatMetadata
241+
:show-inheritance:
242+
243+
.. autoclass:: GpuDeviceInfo
244+
:show-inheritance:
245+
246+
.. autoclass:: Hardware
247+
:show-inheritance:
248+
249+
.. autoclass:: IntMetadata
250+
:show-inheritance:
251+
252+
.. autoclass:: Learning
253+
:show-inheritance:
254+
255+
.. autoclass:: LearningCurve
256+
:show-inheritance:
257+
258+
.. autoclass:: ListMeasurement
259+
:show-inheritance:
260+
261+
.. autoclass:: MeanStd
262+
:show-inheritance:
263+
264+
.. autoclass:: Measurement
265+
:show-inheritance:
266+
267+
.. autoclass:: MetadataBase
268+
:show-inheritance:
269+
270+
.. autoclass:: Resources
271+
:show-inheritance:
272+
273+
.. autoclass:: RunConfig
274+
:show-inheritance:
275+
276+
.. autoclass:: RunIdentity
277+
:show-inheritance:
278+
279+
.. autoclass:: Runtime
280+
:show-inheritance:
281+
282+
.. autoclass:: SingleMeasurement
283+
:show-inheritance:
284+
285+
.. autoclass:: StartupConfig
286+
:show-inheritance:
287+
288+
.. autoclass:: StartupPhase
289+
:show-inheritance:
290+
291+
.. autoclass:: StartupTime
292+
:show-inheritance:
293+
294+
.. autoclass:: StatisticalMeasurement
295+
:show-inheritance:
296+
297+
.. autoclass:: StringMetadata
298+
:show-inheritance:
299+
300+
.. autoclass:: TestPhase
301+
:show-inheritance:
302+
303+
.. autoclass:: Versions
304+
:show-inheritance:

‎docs/source/api/lab/isaaclab.cloner.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,30 @@ Query
5252

5353
.. automodule:: isaaclab.cloner.query
5454
:members:
55+
56+
Additional Public Classes
57+
-------------------------
58+
59+
The following classes are part of the public :mod:`isaaclab.cloner` API.
60+
61+
.. currentmodule:: isaaclab.cloner
62+
63+
.. autosummary::
64+
:nosignatures:
65+
66+
CloneCfg
67+
InclusionSet
68+
ReplicateSession
69+
UsdReplicateContext
70+
71+
.. autoclass:: CloneCfg
72+
:show-inheritance:
73+
74+
.. autoclass:: InclusionSet
75+
:show-inheritance:
76+
77+
.. autoclass:: ReplicateSession
78+
:show-inheritance:
79+
80+
.. autoclass:: UsdReplicateContext
81+
:show-inheritance:

‎docs/source/api/lab/isaaclab.controllers.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,50 @@ Available Pink IK Tasks
6464
^^^^^^^^^^^^^^^^^^^^^^^
6565

6666
.. autoclass:: NullSpacePostureTask
67+
68+
Additional Public Classes
69+
-------------------------
70+
71+
The following classes are part of the public :mod:`isaaclab.controllers.pink_ik` API.
72+
73+
.. currentmodule:: isaaclab.controllers.pink_ik
74+
75+
.. autosummary::
76+
:nosignatures:
77+
78+
DampingTask
79+
DampingTaskCfg
80+
FrameTask
81+
FrameTaskCfg
82+
LocalFrameTask
83+
LocalFrameTaskCfg
84+
NullSpacePostureTaskCfg
85+
PinkIKTaskCfg
86+
PinkKinematicsConfiguration
87+
88+
.. autoclass:: DampingTask
89+
:show-inheritance:
90+
91+
.. autoclass:: DampingTaskCfg
92+
:show-inheritance:
93+
94+
.. autoclass:: FrameTask
95+
:show-inheritance:
96+
97+
.. autoclass:: FrameTaskCfg
98+
:show-inheritance:
99+
100+
.. autoclass:: LocalFrameTask
101+
:show-inheritance:
102+
103+
.. autoclass:: LocalFrameTaskCfg
104+
:show-inheritance:
105+
106+
.. autoclass:: NullSpacePostureTaskCfg
107+
:show-inheritance:
108+
109+
.. autoclass:: PinkIKTaskCfg
110+
:show-inheritance:
111+
112+
.. autoclass:: PinkKinematicsConfiguration
113+
:show-inheritance:

‎docs/source/api/lab/isaaclab.devices.rst‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,54 @@ Retargeters
139139
:inherited-members:
140140
:show-inheritance:
141141
:noindex:
142+
143+
Additional Public Classes
144+
-------------------------
145+
146+
The following classes are part of the public :mod:`isaaclab.devices` API.
147+
148+
.. currentmodule:: isaaclab.devices
149+
150+
.. autosummary::
151+
:nosignatures:
152+
153+
DeviceCfg
154+
DevicesCfg
155+
HaplyDeviceCfg
156+
RetargeterCfg
157+
Se2GamepadCfg
158+
Se2KeyboardCfg
159+
Se2SpaceMouseCfg
160+
Se3GamepadCfg
161+
Se3KeyboardCfg
162+
Se3SpaceMouseCfg
163+
164+
.. autoclass:: DeviceCfg
165+
:show-inheritance:
166+
167+
.. autoclass:: DevicesCfg
168+
:show-inheritance:
169+
170+
.. autoclass:: HaplyDeviceCfg
171+
:show-inheritance:
172+
173+
.. autoclass:: RetargeterCfg
174+
:show-inheritance:
175+
176+
.. autoclass:: Se2GamepadCfg
177+
:show-inheritance:
178+
179+
.. autoclass:: Se2KeyboardCfg
180+
:show-inheritance:
181+
182+
.. autoclass:: Se2SpaceMouseCfg
183+
:show-inheritance:
184+
185+
.. autoclass:: Se3GamepadCfg
186+
:show-inheritance:
187+
188+
.. autoclass:: Se3KeyboardCfg
189+
:show-inheritance:
190+
191+
.. autoclass:: Se3SpaceMouseCfg
192+
:show-inheritance:

0 commit comments

Comments
 (0)