fixed relative paths, symbolic linked readme, and generated doc htmls

haosulab · Jan 10, 2024 · 1fd8611 · 1fd8611
1 parent c3c52b3
commit 1fd8611
Show file tree

Hide file tree

Showing 24 changed files with 9,370 additions and 7 deletions.
diff --git a/doc/index.html b/doc/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./mplib.html"/>
+</head>
+</html>
diff --git a/doc/mplib.html b/doc/mplib.html
diff --git a/doc/mplib/examples.html b/doc/mplib/examples.html
diff --git a/doc/mplib/examples/collision_avoidance.html b/doc/mplib/examples/collision_avoidance.html
diff --git a/doc/mplib/examples/constrained_planning.html b/doc/mplib/examples/constrained_planning.html
diff --git a/doc/mplib/examples/demo.html b/doc/mplib/examples/demo.html
diff --git a/doc/mplib/examples/demo_setup.html b/doc/mplib/examples/demo_setup.html
diff --git a/doc/mplib/examples/detect_collision.html b/doc/mplib/examples/detect_collision.html
diff --git a/doc/mplib/examples/moving_robot.html b/doc/mplib/examples/moving_robot.html
diff --git a/doc/mplib/examples/two_stage_motion.html b/doc/mplib/examples/two_stage_motion.html
diff --git a/doc/mplib/planner.html b/doc/mplib/planner.html
diff --git a/doc/mplib/pymp.html b/doc/mplib/pymp.html
diff --git a/doc/search.js b/doc/search.js
diff --git a/mplib/README.md b/mplib/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/mplib/__init__.py b/mplib/__init__.py
@@ -1,2 +1,5 @@
-from .planner import Planner
+"""
+.. include:: ./README.md
+"""
 
+from mplib.planner import Planner
diff --git a/examples/__init__.py → mplib/examples/__init__.py b/examples/__init__.py → mplib/examples/__init__.py
diff --git a/examples/collision_avoidance.py → mplib/examples/collision_avoidance.py b/examples/collision_avoidance.py → mplib/examples/collision_avoidance.py
@@ -1,5 +1,5 @@
 import sapien.core as sapien
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class PlanningDemo(DemoSetup):
     """ The shows the planner's ability to generate a collision free path with the straight path causes collisions """

diff --git a/examples/constrained_planning.py → mplib/examples/constrained_planning.py b/examples/constrained_planning.py → mplib/examples/constrained_planning.py
@@ -2,7 +2,7 @@
 
 import numpy as np
 import transforms3d
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class ConstrainedPlanningDemo(DemoSetup):
   """

diff --git a/examples/demo.py → mplib/examples/demo.py b/examples/demo.py → mplib/examples/demo.py
@@ -1,5 +1,5 @@
 import sapien.core as sapien
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class PlanningDemo(DemoSetup):
     """

diff --git a/examples/demo_setup.py → mplib/examples/demo_setup.py b/examples/demo_setup.py → mplib/examples/demo_setup.py
diff --git a/examples/detect_collision.py → mplib/examples/detect_collision.py b/examples/detect_collision.py → mplib/examples/detect_collision.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 import mplib
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class DetectCollisionDemo(DemoSetup):
   """

diff --git a/examples/moving_robot.py → mplib/examples/moving_robot.py b/examples/moving_robot.py → mplib/examples/moving_robot.py
@@ -1,5 +1,5 @@
 import sapien.core as sapien
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class PlanningDemo(DemoSetup):
     """ This is identical to demo.py except the whole scene is shifted to the bottom right by 1 meter respectively """

diff --git a/examples/two_stage_motion.py → mplib/examples/two_stage_motion.py b/examples/two_stage_motion.py → mplib/examples/two_stage_motion.py
@@ -1,7 +1,7 @@
 import sapien.core as sapien
 import mplib
 import numpy as np
-from demo_setup import DemoSetup
+from .demo_setup import DemoSetup
 
 class PlanningDemo(DemoSetup):
     """

diff --git a/setup.py b/setup.py
@@ -89,4 +89,6 @@ def build_extension(self, ext):
     ext_modules=[CMakeExtension("mplib.pymp")],
     cmdclass={"build_ext": CMakeBuild},
     zip_safe=False,
+    package_data={"mplib": ["README.md"]},
+    include_package_data=True,
 )