[DOC] Add ddtw distance to the API references (aeon-toolkit#1897)

* Add ddtw distance to the API references * replace ddtw by DDTW in ddtw_alignment_path doc for more consistency in the docs
aadya940 · Aug 3, 2024 · aceca37 · aceca37
1 parent 1aad851
commit aceca37
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/aeon/distances/_ddtw.py b/aeon/distances/_ddtw.py
@@ -322,7 +322,7 @@ def ddtw_alignment_path(
     window: Optional[float] = None,
     itakura_max_slope: Optional[float] = None,
 ) -> Tuple[List[Tuple[int, int]], float]:
-    """Compute the ddtw alignment path between two time series.
+    """Compute the DDTW alignment path between two time series.
 
     Parameters
     ----------

diff --git a/docs/api_reference/distances.rst b/docs/api_reference/distances.rst
@@ -22,6 +22,20 @@ Amerced Dynamic Time Warping (ADTW)
     adtw_cost_matrix
     adtw_alignment_path
 
+Derivative Dynamic Time Warping (DDTW)
+-----------------------------------
+
+.. currentmodule:: aeon.distances
+
+.. autosummary::
+    :toctree: auto_generated/
+    :template: function.rst
+
+    ddtw_distance
+    ddtw_pairwise_distance
+    ddtw_cost_matrix
+    ddtw_alignment_path
+
 Dynamic Time Warping (DTW)
 --------------------------
 
@@ -211,7 +225,6 @@ Weighted Dynamic Time Warping (DTW)
     wdtw_cost_matrix
     wdtw_alignment_path
 
-
 General methods with distance argument
 --------------------------------------