Skip to content

Commit 614f5ed

Browse files
committed
Refresh docs for flattened dartpy API
1 parent 563d033 commit 614f5ed

File tree

20 files changed

+2849
-2856
lines changed

20 files changed

+2849
-2856
lines changed

docs/onboarding/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ graph TB
561561
- `dartpy` (top-level) - Core classes/functions (math, dynamics, collision, simulation, constraint, optimizer) exposed in snake_case
562562
- `dartpy.io` - File parsers (URDF, SDF, SKEL, MJCF) [alias for legacy `utils`]
563563
- `dartpy.gui` - 3D visualization with OSG and ImGui
564-
- Legacy `dartpy.common`/`math`/`dynamics`/`collision`/`simulation`/`constraint`/`optimizer`/`utils` remain importable in DART 7.x but emit `DeprecationWarning` and will be removed in DART 8.0.
564+
- Legacy `dartpy`/`math`/`dynamics`/`collision`/`simulation`/`constraint`/`optimizer`/`utils` remain importable in DART 7.x but emit `DeprecationWarning` and will be removed in DART 8.0.
565565

566566
**Key Files**:
567567

@@ -818,7 +818,7 @@ sequenceDiagram
818818
Python->>dartpy: world = dartpy.World()
819819
dartpy->>DART: World::create()
820820
821-
Python->>dartpy: skel = dartpy.dynamics.Skeleton.create()
821+
Python->>dartpy: skel = dartpy.Skeleton.create()
822822
dartpy->>DART: Skeleton::create()
823823
824824
Python->>dartpy: world.add_skeleton(skel)
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.collision
2-
================
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.collision
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:

docs/python_api/modules/common.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.common
2-
=============
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.common
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.constraint
2-
=================
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.constraint
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.dynamics
2-
===============
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.dynamics
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:

docs/python_api/modules/gui.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@ dartpy.gui
33

44
.. automodule:: dartpy.gui
55
:members:
6-
:undoc-members:
7-
:show-inheritance:

docs/python_api/modules/math.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.math
2-
============
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.math
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.optimizer
2-
================
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.optimizer
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.simulation
2-
=================
1+
dartpy
2+
======
33

4-
.. automodule:: dartpy.simulation
4+
.. note:: Legacy submodules will be removed in DART 8.0; use top-level `dartpy`.
5+
6+
.. automodule:: dartpy
57
:members:
6-
:undoc-members:
7-
:show-inheritance:

docs/python_api/modules/utils.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
dartpy.utils
2-
============
1+
dartpy.io
2+
=========
33

4-
.. automodule:: dartpy.utils
4+
.. note:: Legacy `dartpy.utils` will be removed in DART 8.0; use `dartpy.io`.
5+
6+
.. automodule:: dartpy.io
57
:members:
6-
:undoc-members:
7-
:show-inheritance:

0 commit comments

Comments
 (0)