Skip to content

Commit b7fa021

Browse files
petercorkepetercorke
committed
split function docs into individual files
allows next/prev navigation
1 parent 7f647e1 commit b7fa021

9 files changed

Lines changed: 82 additions & 78 deletions

File tree

‎docs/source/func_2d.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Transforms in 2D
2+
================
3+
4+
.. automodule:: spatialmath.base.transforms2d
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_3d.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Transforms in 3D
2+
================
3+
4+
.. automodule:: spatialmath.base.transforms3d
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_args.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Argument checking
2+
=================
3+
4+
.. automodule:: spatialmath.base.argcheck
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_graphics.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Graphics and animation
2+
======================
3+
4+
.. automodule:: spatialmath.base.animate
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_nd.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Transforms in ND
2+
================
3+
4+
.. automodule:: spatialmath.base.transformsNd
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_quat.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Quaternions
2+
===========
3+
4+
.. automodule:: spatialmath.base.quaternions
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_symbolic.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Symbolic computation
2+
====================
3+
4+
.. automodule:: spatialmath.base.symbolic
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/func_vector.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Vectors
2+
=======
3+
4+
.. automodule:: spatialmath.base.vectors
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members:

‎docs/source/functions.rst‎

Lines changed: 10 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,21 @@
11
******************
22
Function reference
33
******************
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:
164

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-
-------
535

54-
.. automodule:: spatialmath.base.vectors
55-
:members:
56-
:undoc-members:
57-
:show-inheritance:
58-
:inherited-members:
59-
:special-members:
6+
.. toctree::
7+
:maxdepth: 2
608

61-
Graphic animation
62-
-----------------
9+
func_2d
10+
func_3d
11+
func_nd
12+
func_quat
13+
func_symbolic
14+
func_vector
15+
func_args
16+
func_graphics
6317

64-
.. automodule:: spatialmath.base.animate
65-
:members:
66-
:undoc-members:
67-
:show-inheritance:
68-
:inherited-members:
69-
:special-members:
7018

71-
Argument checking
72-
-----------------
7319

74-
.. automodule:: spatialmath.base.argcheck
75-
:members:
76-
:undoc-members:
77-
:show-inheritance:
78-
:inherited-members:
79-
:special-members:
8020

81-
Symbolics
82-
---------
8321

84-
.. automodule:: spatialmath.base.symbolic
85-
:members:
86-
:undoc-members:
87-
:show-inheritance:
88-
:inherited-members:
89-
:special-members:

0 commit comments

Comments
 (0)