Improved documentation. Improved modules documentation index.

fraunhoferportugal · Feb 17, 2022 · b5239cb · b5239cb
1 parent 47ebc38
commit b5239cb
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 2 deletions.
diff --git a/docs/descriptions/modules.rst b/docs/descriptions/modules.rst
@@ -8,4 +8,5 @@ Module Reference
 
 .. toctree::
 
-    modules/tssearch_search
+    modules/tssearch_search
+    modules/tssearch_distances
diff --git a/docs/descriptions/modules/tssearch_distances.rst b/docs/descriptions/modules/tssearch_distances.rst
@@ -0,0 +1,33 @@
+Distances
+=========
+
+.. automodule:: tssearch.distances
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Lockstep Distances
+------------------
+
+.. automodule:: tssearch.distances.lockstep_distances
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Elastic Distances
+-----------------
+
+.. automodule:: tssearch.distances.elastic_distances
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Time Distances
+--------------
+
+.. automodule:: tssearch.distances.time_distances
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/descriptions/modules/tssearch_search.rst b/docs/descriptions/modules/tssearch_search.rst
@@ -1,4 +1,4 @@
-search
+Search
 ======
 
 .. automodule:: tssearch.search
@@ -18,6 +18,14 @@ segmentation
 ------------
 
 .. automodule:: tssearch.search.segmentation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+utils
+-----
+
+.. automodule:: tssearch.search.search_utils
     :members:
     :undoc-members:
     :show-inheritance: