diff options
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r-- | docs/source/index.rst | 32 |
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` |