Skip to content

Commit c09fbfc

Browse files
committed
docs: add Robot convenience wrappers to API docs and cross-reference chapter pages
1 parent 71d0a9d commit c09fbfc

6 files changed

Lines changed: 27 additions & 0 deletions

File tree

docs/src/lib/dynamics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
*Textbook Chapter 8*
44

5+
!!! tip "Robot convenience wrappers"
6+
For simplified calls using a [`Robot`](@ref) model (e.g., `inverse_dynamics(robot, q, dq, ddq)`), see [Robot Model](@ref).
7+
58
```@autodocs
69
Modules = [ModernRoboticsBook]
710
Pages = ["ModernRoboticsBook.jl"]

docs/src/lib/forward-kinematics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
*Textbook Chapter 4*
44

5+
!!! tip "Robot convenience wrappers"
6+
For simplified calls using a [`Robot`](@ref) model (e.g., `forward_kinematics_space(robot, q)`), see [Robot Model](@ref).
7+
58
```@autodocs
69
Modules = [ModernRoboticsBook]
710
Pages = ["ModernRoboticsBook.jl"]

docs/src/lib/inverse-kinematics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
*Textbook Chapter 6*
44

5+
!!! tip "Robot convenience wrappers"
6+
For simplified calls using a [`Robot`](@ref) model (e.g., `inverse_kinematics_body(robot, target, guess, ε_ω, ε_v)`), see [Robot Model](@ref).
7+
58
```@autodocs
69
Modules = [ModernRoboticsBook]
710
Pages = ["ModernRoboticsBook.jl"]

docs/src/lib/robot-control.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
*Textbook Chapter 11*
44

5+
!!! tip "Robot convenience wrappers"
6+
For simplified calls using a [`Robot`](@ref) model (e.g., `computed_torque(robot, q, dq, ...)`), see [Robot Model](@ref).
7+
58
```@autodocs
69
Modules = [ModernRoboticsBook]
710
Pages = ["ModernRoboticsBook.jl"]

docs/src/lib/robot-model.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
# Robot Model
22

3+
## Type and Loading
4+
35
```@autodocs
46
Modules = [ModernRoboticsBook]
57
Pages = ["robot.jl"]
68
Filter = t -> nameof(t) in [:Robot, :load_robot]
79
```
10+
11+
## Convenience Wrappers
12+
13+
The following functions accept a [`Robot`](@ref) as their first argument, automatically supplying the robot's kinematic and dynamic parameters. See the corresponding chapter pages for algorithmic details.
14+
15+
```@autodocs
16+
Modules = [ModernRoboticsBook]
17+
Pages = ["robot.jl"]
18+
Filter = t -> nameof(t) ∉ [:Robot, :load_robot]
19+
```

docs/src/lib/velocity-kinematics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
*Textbook Chapter 5*
44

5+
!!! tip "Robot convenience wrappers"
6+
For simplified calls using a [`Robot`](@ref) model (e.g., `jacobian_space(robot, q)`), see [Robot Model](@ref).
7+
58
```@autodocs
69
Modules = [ModernRoboticsBook]
710
Pages = ["ModernRoboticsBook.jl"]

0 commit comments

Comments
 (0)