diff --git a/docs/conf.py b/docs/conf.py index ad869bc..da32fe0 100644 --- 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 index 3e9de6f..0e6f0a9 100644 --- a/docs/modules/result.rst +++ b/docs/modules/result.rst @@ -1,7 +1,9 @@ +.. module:: dtwalign.result + ====== Result ====== -.. automodule:: dtwalign.result +.. autoclass:: DtwResult :members: \ No newline at end of file diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 46cdd14..403caa8 100644 --- 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