(add) api ref

elkotito · Jul 8, 2019 · 46bb085 · 46bb085
1 parent 8f7f757
commit 46bb085
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 [![Documentation Status](https://readthedocs.org/projects/dtwalign/badge/?version=latest)](https://dtwalign.readthedocs.io/en/latest/?badge=latest)
 
 Comprehensive dynamic time warping module for python.
+Documentation is [available via ReadTheDocs](https://dtwalign.readthedocs.io/en/latest/index.html).
 
 ## Installation
 ```

diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,11 @@
+====
+API Reference
+====
+
+.. toctree::
+    :maxdepth: 1
+
+    modules/dtw
+    modules/result
+    modules/step_pattern
+    modules/window
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,11 +15,6 @@ Installation
 pip install dtwalign
 ```
 
-Fast computation
-----------------
-
-by [Numba](https://numba.pydata.org)
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/docs/modules/dtw.rst b/docs/modules/dtw.rst
@@ -0,0 +1,7 @@
+===
+DTW
+===
+
+.. automodule:: dtwalign.dtw
+   :members:
+   :show-inheritance:
diff --git a/docs/modules/result.rst b/docs/modules/result.rst
@@ -0,0 +1,8 @@
+======
+Result
+======
+
+.. automodule:: dtwalign.result
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/modules/step_pattern.rst b/docs/modules/step_pattern.rst
@@ -0,0 +1,8 @@
+=============
+Step patterns
+=============
+
+.. automodule:: dtwalign.step_pattern
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/modules/window.rst b/docs/modules/window.rst
@@ -0,0 +1,8 @@
+=======
+Windows
+=======
+
+.. automodule:: dtwalign.window
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -2,3 +2,4 @@
 Tutorial
 ========
 
+TODO
diff --git a/dtwalign/dtw.py b/dtwalign/dtw.py
@@ -1,28 +1,27 @@
 # -*- coding: utf-8 -*-
-"""A complehensive dynamic time warping package.
-
-The MIT License (MIT)
-
-Copyright (c) 2018 statefb.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-"""
+# A complehensive dynamic time warping package.
+
+# The MIT License (MIT)
+
+# Copyright (c) 2018 statefb.
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
 import numpy as np
 from scipy.spatial.distance import cdist