Skip to content

Commit ced1264

Browse files
petercorkepetercorke
committed
split doco into small files
allows better navigation with next/prev
1 parent 54afae9 commit ced1264

18 files changed

Lines changed: 181 additions & 0 deletions

‎docs/source/2d_orient_SO2.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
SO(2) matrix
2+
^^^^^^^^^^^^
3+
4+
.. autoclass:: spatialmath.pose2d.SO2
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove

‎docs/source/2d_pose_SE2.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
SE(2) matrix
2+
^^^^^^^^^^^^
3+
4+
.. autoclass:: spatialmath.pose2d.SE2
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove

‎docs/source/2d_pose_twist.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
se(2) twist
2+
^^^^^^^^^^^
3+
4+
.. automodule:: spatialmath.Twist2
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove

‎docs/source/3d_orient_SO3.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
3+
SO(3) matrix
4+
^^^^^^^^^^^^
5+
6+
.. autoclass:: spatialmath.pose3d.SO3
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
:inherited-members:
11+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
12+
:exclude-members: count, copy, index, sort, remove

‎docs/source/3d_orient_unitquaternion.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Unit quaternion
2+
^^^^^^^^^^^^^^^
3+
4+
.. autoclass:: spatialmath.quaternion.UnitQuaternion
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove, arghandler, binop, unop,
11+

‎docs/source/3d_plane.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Plane
2+
^^^^^
3+
4+
.. automodule:: spatialmath.geom3d.Plane
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __rmul__, __eq__, __ne__, __init__, __or__, __xor__

‎docs/source/3d_plucker.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Plucker line
2+
^^^^^^^^^^^^
3+
4+
.. automodule:: spatialmath.geom3d.Plucker
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __rmul__, __eq__, __ne__, __init__, __or__, __xor__

‎docs/source/3d_pose_SE3.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
SE(3) matrix
2+
^^^^^^^^^^^^
3+
4+
.. autoclass:: spatialmath.pose3d.SE3
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove, arghandler, binop, unop

‎docs/source/3d_pose_twist.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
se(3) twist
2+
^^^^^^^^^^^
3+
4+
.. automodule:: spatialmath.Twist3
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove

‎docs/source/3d_quaternion.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Quaternion
2+
^^^^^^^^^^
3+
4+
.. autoclass:: spatialmath.quaternion.Quaternion
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
10+
:exclude-members: count, copy, index, sort, remove

0 commit comments

Comments
 (0)