diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/conf.py | 2 | ||||
-rw-r--r-- | docs/source/index.rst | 25 |
2 files changed, 26 insertions, 1 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 0caefae..e114e2c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,7 +38,7 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', + 'sphinx.ext.viewcode','sphinx.ext.autodoc', 'sphinxcontrib.napoleon' ] # Add any paths that contain templates here, relative to this directory. 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: |