8000 polish docs · navrobot/robotics-toolbox-python@2ca8050 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2ca8050

Browse files
committed
polish docs
README and sphinx
1 parent 6b12278 commit 2ca8050

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![Build Status](https://github.com/petercorke/robotics-toolbox-python/workflows/build/badge.svg?branch=master)](https://github.com/petercorke/robotics-toolbox-python/actions?query=workflow%3Abuild)
1212
[![Coverage](https://codecov.io/gh/petercorke/robotics-toolbox-python/branch/master/graph/badge.svg)](https://codecov.io/gh/petercorke/robotics-toolbox-python)
1313
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
14-
14+
[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io)
1515

1616

1717

docs/source/arm_ets.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
Arm Type Robots - ETS
2-
==============================================================
2+
=====================
33

44
.. codeauthor:: Jesse Haviland
55

6-
ETS
7-
------------
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
10+
11+
>>> import roboticstoolbox as rtb
12+
>>> rtb.models.list(mtype="ETS")
13+
14+
ETS - 3D
15+
--------
816
.. automodule:: roboticstoolbox.robot.ETS
917
:members:
1018
:undoc-members:
@@ -13,6 +21,16 @@ ETS
1321
:special-members:
1422
:exclude-members: count, index, sort, remove, __dict__, __weakref__, __add__, __init__, __repr__, __str__, __module__
1523

24+
ETS - 2D
25+
--------
26+
.. automodule:: roboticstoolbox.robot.ETS2
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
:inherited-members:
31+
:special-members:
32+
:exclude-members: count, index, sort, remove, __dict__, __weakref__, __add__, __init__, __repr__, __str__, __module__
33+
1634
ET
1735
------------
1836
.. automodule:: roboticstoolbox.robot.ET

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ Robotics Toolbox for Python
1111
:maxdepth: 2
1212

1313
arm_dh
14-
arm_ets
14+
arm_ets
15+
arm_urdf

0 commit comments

Comments
 (0)
0