sphinx.ext.napoleon

elkotito · Jul 9, 2019 · 1e53640 · 1e53640
1 parent 11ae4fa
commit 1e53640
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,7 +32,8 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
-    'sphinx.ext.viewcode',
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/modules/result.rst b/docs/modules/result.rst
@@ -1,7 +1,9 @@
+.. module:: dtwalign.result
+
 ======
 Result
 ======
 
-.. automodule:: dtwalign.result
+.. autoclass:: DtwResult
    :members:
 
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -26,7 +26,7 @@ Firstly, let's generate toy data for this tutorial.
 
 .. image:: img/tutorial/toy_data.png
 
-Then run :func:`~dtwalign.dtw` method which returns :func:`~dtwalign.result.DtwResult` object.
+Then run :func:`dtwalign.dtw` method which returns :func:`~dtwalign.result.DtwResult` object.
 
 .. code-block:: python