Add autodoc_default_options to conf.py

haosulab · Apr 16, 2024 · c585a9c · c585a9c
1 parent 3927715
commit c585a9c
Show file tree

Hide file tree

Showing 13 changed files with 9 additions and 39 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,7 +35,16 @@
 
 templates_path = ["_templates"]
 exclude_patterns = []
+
 maximum_signature_line_length = 88  # limit maximum method/function signature length
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+    "inherited-members": True,
+    "show-inheritance": True,
+    "undoc-members": True,
+    "special-members": "__init__",
+}
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/source/reference/Planner.rst b/docs/source/reference/Planner.rst
@@ -2,6 +2,3 @@
 -------------
 
 .. autoclass:: mplib.Planner
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/PlanningWorld.rst b/docs/source/reference/PlanningWorld.rst
@@ -2,6 +2,3 @@
 -------------------
 
 .. autoclass:: mplib.PlanningWorld
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/collision_detection/fcl.rst b/docs/source/reference/collision_detection/fcl.rst
@@ -2,6 +2,3 @@ fcl
 ----------
 
 .. automodule:: mplib.collision_detection.fcl
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/docs/source/reference/collision_detection/index.rst b/docs/source/reference/collision_detection/index.rst
@@ -2,9 +2,6 @@ collision_detection
 ------------------------------------------
 
 .. automodule:: mplib.collision_detection
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/reference/core/ArticulatedModel.rst b/docs/source/reference/core/ArticulatedModel.rst
@@ -2,6 +2,3 @@
 -------------------------
 
 .. autoclass:: mplib.ArticulatedModel
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/core/AttachedBody.rst b/docs/source/reference/core/AttachedBody.rst
@@ -2,6 +2,3 @@
 -------------------------
 
 .. autoclass:: mplib.AttachedBody
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/kinematics/kdl.rst b/docs/source/reference/kinematics/kdl.rst
@@ -2,6 +2,3 @@ kdl
 -------
 
 .. automodule:: mplib.kinematics.kdl
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/docs/source/reference/kinematics/pinocchio.rst b/docs/source/reference/kinematics/pinocchio.rst
@@ -2,6 +2,3 @@ pinocchio
 --------------
 
 .. automodule:: mplib.kinematics.pinocchio
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/docs/source/reference/planning/ompl.rst b/docs/source/reference/planning/ompl.rst
@@ -2,6 +2,3 @@ ompl
 ------------
 
 .. automodule:: mplib.planning.ompl
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/docs/source/reference/sapien_utils.rst b/docs/source/reference/sapien_utils.rst
@@ -2,11 +2,5 @@
 ------------------------------------------
 
 .. autoclass:: mplib.sapien_utils.SapienPlanningWorld
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 .. autoclass:: mplib.sapien_utils.SapienPlanner
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/urdf_utils.rst b/docs/source/reference/urdf_utils.rst
@@ -2,6 +2,3 @@
 -------------------
 
 .. automodule:: mplib.urdf_utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/reference/utils/pose.rst b/docs/source/reference/utils/pose.rst
@@ -2,6 +2,3 @@
 -------------------------
 
 .. autoclass:: mplib.Pose
-   :members:
-   :undoc-members:
-   :show-inheritance: