Skip to content

Commit

Permalink
Clean up API doc overview
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderFabisch committed Nov 30, 2023
1 parent f3b7b53 commit e40a76a
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,25 @@ You can also search for specific modules, classes, or functions in the
~movement_primitives.dmp.DMPWithFinalVelocity
~movement_primitives.dmp.CartesianDMP
~movement_primitives.dmp.DualCartesianDMP
~movement_primitives.dmp.DMPBase
~movement_primitives.dmp.WeightParametersMixin

Coupling Terms
--------------

Coupling terms can be used to adapt the movement generated by a DMP online.
Not all coupling terms are compatible with all types of DMPs.

.. autosummary::
:toctree: _apidoc/
:template: class.rst

~movement_primitives.dmp.CouplingTermPos1DToPos1D
~movement_primitives.dmp.CouplingTermObstacleAvoidance2D
~movement_primitives.dmp.CouplingTermObstacleAvoidance3D
~movement_primitives.dmp.CouplingTermPos3DToPos3D
~movement_primitives.dmp.CouplingTermDualCartesianPose
~movement_primitives.dmp.CouplingTermObstacleAvoidance3D
~movement_primitives.dmp.CouplingTermDualCartesianDistance
~movement_primitives.dmp.CouplingTermDualCartesianTrajectory

.. autosummary::
:toctree: _apidoc/

~movement_primitives.dmp.dmp_transformation_system
~movement_primitives.dmp.canonical_system_alpha
~movement_primitives.dmp.phase
~movement_primitives.dmp.obstacle_avoidance_acceleration_2d
~movement_primitives.dmp.obstacle_avoidance_acceleration_3d


:mod:`movement_primitives.promp`
================================
Expand Down

0 comments on commit e40a76a

Please sign in to comment.