diff options
author | Rémi Flamary <remi.flamary@gmail.com> | 2016-10-25 10:44:55 +0200 |
---|---|---|
committer | Rémi Flamary <remi.flamary@gmail.com> | 2016-10-25 10:44:55 +0200 |
commit | ab27b8387201e57173255b2d22ad3c8d5057ad8b (patch) | |
tree | a85eaac549f6bf0fd7d128d06abb0a530f7e8dec | |
parent | 7b9f4e9d4b198183929c60eceec1a419b5212e2d (diff) |
complet doc
-rw-r--r-- | docs/source/conf.py | 2 | ||||
-rw-r--r-- | docs/source/index.rst | 21 |
2 files changed, 16 insertions, 7 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index e114e2c..51b71c9 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.autodoc', 'sphinxcontrib.napoleon' + 'sphinx.ext.viewcode', 'sphinx.ext.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 8613bfd..c95e847 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,9 +11,12 @@ Contents: .. toctree:: :maxdepth: 2 +Module list +=========== + Module ot -========= +--------- This module provide easy access to solvers for the most common OT problems @@ -21,34 +24,40 @@ This module provide easy access to solvers for the most common OT problems :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: + +Examples +======== + +.. literalinclude:: ../../examples/demo_OT_1D.py + Indices and tables ================== |