Update mplib API Reference with new API

haosulab · Feb 6, 2024 · ce707d0 · ce707d0
1 parent 3dde1b6
commit ce707d0
Show file tree

Hide file tree

Showing 11 changed files with 84 additions and 45 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 myst-parser
 sphinx-rtd-theme
+sphinx-copybutton
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,9 +29,9 @@ API Reference
 -------------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   mplib.pymp
+   pymp/index
 
 Indices and tables
 ==================

diff --git a/docs/source/mplib.pymp.rst b/docs/source/mplib.pymp.rst
diff --git a/docs/source/mplib.rst b/docs/source/mplib.rst
@@ -7,4 +7,4 @@ mplib.planner
 .. automodule:: mplib.planner
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/docs/source/pymp/collision_detection/fcl.rst b/docs/source/pymp/collision_detection/fcl.rst
@@ -0,0 +1,7 @@
+fcl
+----------
+
+.. automodule:: mplib.pymp.collision_detection.fcl
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/source/pymp/collision_detection/index.rst b/docs/source/pymp/collision_detection/index.rst
@@ -0,0 +1,4 @@
+.. automodule:: mplib.pymp.collision_detection
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pymp/index.rst b/docs/source/pymp/index.rst
@@ -0,0 +1,44 @@
+mplib API Reference
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   ../mplib
+   pymp
+
+collision_detection
+------------------------------------------
+
+Collision detection submodule
+
+.. toctree::
+   :maxdepth: 1
+
+   collision_detection/index
+
+.. toctree::
+   :maxdepth: 2
+
+   collision_detection/fcl
+
+kinematics
+-------------------------------------------
+
+Kinematics submodule
+
+.. toctree::
+   :maxdepth: 2
+
+   kinematics/pinocchio
+   kinematics/kdl
+
+planning
+--------------------------
+
+Planning submodule
+
+.. toctree::
+   :maxdepth: 2
+
+   planning/ompl
diff --git a/docs/source/pymp/kinematics/kdl.rst b/docs/source/pymp/kinematics/kdl.rst
@@ -0,0 +1,7 @@
+kdl
+-------
+
+.. automodule:: mplib.pymp.kinematics.kdl
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/source/pymp/kinematics/pinocchio.rst b/docs/source/pymp/kinematics/pinocchio.rst
@@ -0,0 +1,7 @@
+pinocchio
+--------------
+
+.. automodule:: mplib.pymp.kinematics.pinocchio
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/source/pymp/planning/ompl.rst b/docs/source/pymp/planning/ompl.rst
@@ -0,0 +1,7 @@
+ompl
+------------
+
+.. automodule:: mplib.pymp.planning.ompl
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/source/pymp/pymp.rst b/docs/source/pymp/pymp.rst
@@ -0,0 +1,4 @@
+.. automodule:: mplib.pymp
+   :members:
+   :undoc-members:
+   :show-inheritance: