Skip to content

Commit 4b49399

Browse files
petercorkepetercorke
committed
Split the .rst files in order to split the generated HTML file
1 parent 033510f commit 4b49399

5 files changed

Lines changed: 235 additions & 229 deletions

File tree

‎docs/source/classes-2d.rst‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2D-space
2+
========
3+
4+
Pose in 2D
5+
----------
6+
7+
SE(2) matrix
8+
^^^^^^^^^^^^
9+
10+
.. autclass:: spatialmath.pose2d.SE2
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
:inherited-members:
15+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
16+
:exclude-members: count, copy, index, sort, remove
17+
18+
se(2) twist
19+
^^^^^^^^^^^
20+
21+
.. automodule:: spatialmath.Twist2
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
:inherited-members:
26+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
27+
:exclude-members: count, copy, index, sort, remove
28+
29+
Orientation in 2D
30+
-----------------
31+
32+
SO(2) matrix
33+
^^^^^^^^^^^^
34+
35+
.. autclass:: spatialmath.pose2d.SO2
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
:inherited-members:
40+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
41+
:exclude-members: count, copy, index, sort, remove
42+
43+
44+
45+
46+
Geometry
47+
--------
48+
49+
.. automodule:: spatialmath.geom2d
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
:inherited-members:
54+
:special-members: __mul__, __rmul__, __eq__, __ne__, __init__, __or__, __xor__
55+
56+
57+

‎docs/source/classes-3d.rst‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
3D-space
2+
========
3+
4+
Pose in 3D
5+
----------
6+
7+
SE(3) matrix
8+
^^^^^^^^^^^^
9+
10+
.. autoclass:: spatialmath.pose3d.SE3
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
:inherited-members:
15+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
16+
:exclude-members: count, copy, index, sort, remove, arghandler, binop, unop
17+
18+
se(3) twist
19+
^^^^^^^^^^^
20+
21+
.. automodule:: spatialmath.Twist3
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
:inherited-members:
26+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
27+
:exclude-members: count, copy, index, sort, remove
28+
29+
Orientation in 3D
30+
-----------------
31+
32+
SO(3) matrix
33+
^^^^^^^^^^^^
34+
35+
.. autoclass:: spatialmath.pose3d.SO3
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
:inherited-members:
40+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
41+
:exclude-members: count, copy, index, sort, remove
42+
43+
Unit quaternion
44+
^^^^^^^^^^^^^^^
45+
46+
.. autoclass:: spatialmath.quaternion.UnitQuaternion
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:
50+
:inherited-members:
51+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
52+
:exclude-members: count, copy, index, sort, remove
53+
54+
55+
6D spatial vectors
56+
------------------
57+
58+
.. automodule:: spatialmath.spatialvector
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
:inherited-members:
63+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
64+
:exclude-members: count, copy, index, sort, remove
65+
66+
67+
General quaternions
68+
-------------------
69+
70+
.. autoclass:: spatialmath.quaternion.Quaternion
71+
:members:
72+
:undoc-members:
73+
:show-inheritance:
74+
:inherited-members:
75+
:special-members: __mul__, __truediv__, __add__, __sub__, __eq__, __ne__, __pow__, __init__
76+
:exclude-members: count, copy, index, sort, remove
77+
78+
Geometry
79+
--------
80+
81+
.. automodule:: spatialmath.geom3d
82+
:members:
83+
:undoc-members:
84+
:show-inheritance:
85+
:inherited-members:
86+
:special-members: __mul__, __rmul__, __eq__, __ne__, __init__, __or__, __xor__

‎docs/source/functions.rst‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
***********************
2+
Function library (base)
3+
***********************
4+
5+
blah blah blah
6+
7+
Transforms in 2D
8+
================
9+
10+
.. automodule:: spatialmath.base.transforms2d
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
:inherited-members:
15+
:special-members:
16+
17+
Transforms in 3D
18+
================
19+
20+
.. automodule:: spatialmath.base.transforms3d
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
:inherited-members:
25+
:special-members:
26+
27+
28+
Transforms in ND
29+
================
30+
31+
.. automodule:: spatialmath.base.transformsNd
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
:inherited-members:
36+
:special-members:
37+
38+
Quaternions
39+
===========
40+
41+
.. automodule:: spatialmath.base.quaternions
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
:inherited-members:
46+
:special-members:
47+
48+
Utility
49+
=======
50+
51+
Vectors
52+
-------
53+
54+
.. automodule:: spatialmath.base.vectors
55+
:members:
56+
:undoc-members:
57+
:show-inheritance:
58+
:inherited-members:
59+
:special-members:
60+
61+
Graphic animation
62+
-----------------
63+
64+
.. automodule:: spatialmath.base.vectors
65+
:members:
66+
:undoc-members:
67+
:show-inheritance:
68+
:inherited-members:
69+
:special-members:
70+
71+
Argument checking
72+
-----------------
73+
74+
.. automodule:: spatialmath.base.argcheck
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
:inherited-members:
79+
:special-members:
80+

‎docs/source/index.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,7 @@ Spatial Maths for Python
1111
:maxdepth: 2
1212

1313
intro
14+
3D-space
1415
spatialmath
15-
indices
16+
functions
17+
indices

0 commit comments

Comments
 (0)