Skip to content

Commit

Permalink
add PlanarMechanics to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
baggepinnen committed Sep 11, 2024
1 parent 27612a7 commit 1856b4f
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ Pkg.add("Multibody")

## Frames
```@autodocs
Modules = [Multibody]
Pages = ["frames.jl"]
Modules = [Multibody, Multibody.PlanarMechanics]
Pages = ["frames.jl", "PlanarMechanics/utils.jl"]
```

## Joints
Expand All @@ -192,8 +192,8 @@ A [`Spherical`](@ref) joints restricts all translational degrees of freedom, but
Some joints offer the option to add 1-dimensional components to them by providing the keyword `axisflange = true`. This allows us to add, e.g., springs, dampers, sensors, and actuators to the joint.

```@autodocs
Modules = [Multibody]
Pages = ["joints.jl", "fancy_joints.jl"]
Modules = [Multibody, Multibody.PlanarMechanics]
Pages = ["joints.jl", "fancy_joints.jl", "PlanarMechanics/joints.jl"]
```

## Components
Expand All @@ -206,8 +206,8 @@ A rod without a mass (just a translation), is modeled using [`FixedTranslation`]


```@autodocs
Modules = [Multibody]
Pages = ["components.jl", "wheels.jl"]
Modules = [Multibody, Multibody.PlanarMechanics]
Pages = ["components.jl", "wheels.jl", "PlanarMechanics/components.jl"]
```

## Forces
Expand All @@ -220,13 +220,13 @@ Pages = ["forces.jl"]
A sensor is an object that translates quantities in the mechanical domain into causal signals which can interact with causal components from [ModelingToolkitStandardLibrary.Blocks](https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/API/blocks/), such as control systems etc.

```@autodocs
Modules = [Multibody]
Pages = ["sensors.jl"]
Modules = [Multibody, Multibody.PlanarMechanics]
Pages = ["sensors.jl", "PlanarMechanics/sensors.jl"]
```

## Orientation utilities
```@autodocs
Modules = [Multibody]
Modules = [Multibody, Multibody.PlanarMechanics]
Pages = ["orientation.jl"]
```

Expand Down

0 comments on commit 1856b4f

Please sign in to comment.