summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2016-10-24 13:57:31 +0200
committerRémi Flamary <remi.flamary@gmail.com>2016-10-24 13:57:31 +0200
commitcfdfd3d4d2791d45cde0bf4512c15039c725bd3e (patch)
tree7e9ee96822b4afea120ea26ff873d30c9696913e /docs/source/index.rst
parentdef8eb0844e95d82b25c0a79c3be42bfaacb100c (diff)
move doc
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..e96f544
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,32 @@
+.. POT documentation master file, created by
+ sphinx-quickstart on Mon Oct 24 11:10:10 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to POT's documentation!
+===============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+.. automodule:: ot
+ :members:
+.. automodule:: ot.emd
+ :members:
+.. automodule:: ot.bregman
+ :members:
+.. automodule:: ot.utils
+ :members:
+.. automodule:: ot.datasets
+ :members:
+.. automodule:: ot.plot
+ :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`