10000 polish doco · navrobot/robotics-toolbox-python@636b57d · GitHub
[go: up one dir, main page]
Skip to content

Commit 636b57d

Browse files
petercorkepetercorke
committed
polish doco
add lots of docstrings for DHLink and subclasses
1 parent ec02db6 commit 636b57d

File tree

5 files changed

+391
-129
lines changed

5 files changed

+391
-129
lines changed

‎docs/source/arm_dh.rst

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
1-
Arm Type Robots - DH
2-
====================
1+
Denavit-Hartenberg models
2+
=========================
33

44
.. codeauthor:: Jesse Haviland
55

6-
A number of models are defined in terms of Denavit-Hartenberg parameters, either
7-
standard or modified. They can be listed by:
8-
9-
.. runblock:: pycon
106

11-
>>> import roboticstoolbox as rtb
12-
>>> rtb.models.list(mtype="DH")
137

148
DHRobot
159
-------
@@ -20,7 +14,7 @@ DHRobot
2014

2115
The various :ref:`DH Models` all subclass this class.
2216

23-
.. automodule:: roboticstoolbox.robot.DHRobot
17+
.. automodule:: roboticstoolbox.robot.DHRobot.DHRobot
2418
:members:
2519
:undoc-members:
2620
:show-inheritance:
@@ -36,51 +30,51 @@ The ``DHRobot`` is defined by a list of ``DHLink`` subclass objects.
3630
:parts: 2
3731

3832

39-
.. automodule:: roboticstoolbox.robot.DHLink
33+
.. autoclass:: roboticstoolbox.robot.DHLink
4034
:members:
4135
:undoc-members:
4236
:show-inheritance:
4337
:inherited-members:
4438

4539
Revolute - standard DH
4640
^^^^^^^^^^^^^^^^^^^^^^
47-
.. automodule:: roboticstoolbox.robot.RevoluteDH
48-
:members:
49-
:undoc-members:
41+
42+
.. autoclass:: roboticstoolbox.robot.DHLink.RevoluteDH
5043
:show-inheritance:
51-
:inherited-members:
5244

5345
Prismatic - standard DH
5446
^^^^^^^^^^^^^^^^^^^^^^^
55-
.. automodule:: roboticstoolbox.robot.PrismaticDH
56-
:members:
57-
:undoc-members:
47+
48+
.. autoclass:: roboticstoolbox.robot.DHLink.PrismaticDH
5849
:show-inheritance:
59-
:inherited-members:
6050

6151

6252
Revolute - modified DH
6353
^^^^^^^^^^^^^^^^^^^^^^
64-
.. automodule:: roboticstoolbox.robot.RevoluteMDH
65-
:members:
66-
:undoc-members:
54+
55+
.. autoclass:: roboticstoolbox.robot.DHLink.RevoluteMDH
6756
:show-inheritance:
68-
:inherited-members:
6957

7058
Prismatic - modified DH
7159
^^^^^^^^^^^^^^^^^^^^^^^
72-
.. automodule:: roboticstoolbox.robot.PrismaticMDH
73-
:members:
74-
:undoc-members:
60+
61+
.. autoclass:: roboticstoolbox.robot.DHLink.PrismaticMDH
7562
:show-inheritance:
76-
:inherited-members:
7763

7864

7965
.. _DH Models:
8066

8167
Models
8268
------
8369

70+
A number of models are defined in terms of Denavit-Hartenberg parameters, either
71+
standard or modified. They can be listed by:
72+
73+
.. runblock:: pycon
74+
75+
>>> import roboticstoolbox as rtb
76+
>>> rtb.models.list(mtype="DH")
77+
8478
.. automodule:: roboticstoolbox.models.DH
8579
:members:
8680
:undoc-members:

‎docs/source/arm_ets.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1-
Arm Type Robots - ETS
2-
=====================
1+
Elementary transform sequence (ETS) models
2+
==========================================
33

44
.. codeauthor:: Jesse Haviland
55

6-
A number of models are defined in terms of Denavit-Hartenberg parameters, either
7-
standard or modified. They can be listed by:
6+
A number of models are defined in terms of elementary transform sequences.
7+
They can be listed by:
88

99
.. runblock:: pycon
1010

1111
>>> import roboticstoolbox as rtb
1212
>>> rtb.models.list(mtype="ETS")
1313

14+
:references:
15+
16+
- https://petercorke.com/robotics/a-simple-and-systematic-approach-to-assigning-denavit-hartenberg-parameters/
17+
1418
ETS - 3D
1519
--------
1620
.. automodule:: roboticstoolbox.robot.ETS

‎docs/source/arm_urdf.rst

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
URDF Robot models
2+
=================
3+
4+
.. codeauthor:: Jesse Haviland
5+
6+
7+
ERobot
8+
-------
9+
10+
.. inheritance-diagram:: roboticstoolbox.ERobot
11+
:top-classes: roboticstoolbox.Robot
12+
:parts: 2
13+
14+
The various models :ref:`E Models` all subclass this class.
15+
16+
.. automodule:: roboticstoolbox.robot.ERobot
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:
20+
:inherited-members:
21+
22+
ELink
23+
-------
24+
25+
The ``ERobot`` is defined by a tree of ``ELink`` subclass objects.
26+
27+
.. inheritance-diagram:: roboticstoolbox.ELink
28+
:top-classes: roboticstoolbox.robot.Link
29+
:parts: 2
30+
31+
.. automodule:: roboticstoolbox.robot.ELink
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
:inherited-members:
36+
37+
38+
.. _E Models:
39+
40+
Models
41+
------
42+
43+
A number of models are defined in terms of Denavit-Hartenberg parameters, either
44+
standard or modified. They can be listed by:
45+
46+
.. runblock:: pycon
47+
48+
>>> import roboticstoolbox as rtb
49+
>>> rtb.models.list(mtype="URDF")
50+
51+
.. automodule:: roboticstoolbox.models.URDF
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎docs/source/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Robotics Toolbox for Python
1010
.. toctree::
1111
:maxdepth: 2
1212

13-
arm_dh
14-
arm_ets
15-
arm_urdf
13+
intro
14+
arm
15+
mobile
16+

0 commit comments

Comments
 (0)
0