summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2016-10-25 10:24:55 +0200
committerRémi Flamary <remi.flamary@gmail.com>2016-10-25 10:24:55 +0200
commit7b9f4e9d4b198183929c60eceec1a419b5212e2d (patch)
treeef960a7fd7a4dd4702c9724b60878c2fc20fef7e /docs/source/index.rst
parent041f9bca2e89d1d111b553159aed862291630b00 (diff)
set numpy doc format
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e96f544..8613bfd 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -11,16 +11,41 @@ Contents:
.. toctree::
:maxdepth: 2
+
+Module ot
+=========
+
+This module provide easy access to solvers for the most common OT problems
+
.. automodule:: ot
:members:
+
+Module ot.emd
+=========
.. automodule:: ot.emd
:members:
+
+Module ot.bregman
+=========
+
.. automodule:: ot.bregman
:members:
+
+Module ot.utils
+=========
+
.. automodule:: ot.utils
:members:
+
+Module ot.datasets
+=========
+
.. automodule:: ot.datasets
:members:
+
+Module ot.plot
+=========
+
.. automodule:: ot.plot
:members: