diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2020-04-24 16:20:37 +0200 |
|---|---|---|
| committer | Rémi Flamary <remi.flamary@gmail.com> | 2020-04-24 16:20:37 +0200 |
| commit | 1a3249dd6d6971de23534b797ce81fd670befa2b (patch) | |
| tree | 7c64ea6b296d1af78a36d3473deab1d8e150762c /docs | |
| parent | fe704c348e2f1fc69c0ecd801e8fefd6888a215d (diff) | |
awesome mini gallery
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/all.rst | 111 | ||||
| -rw-r--r-- | docs/source/conf.py | 3 |
2 files changed, 27 insertions, 87 deletions
diff --git a/docs/source/all.rst b/docs/source/all.rst index fb6f218..d7b878f 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -4,96 +4,33 @@ API and modules =============== -ot --- +.. currentmodule:: ot -.. automodule:: ot - :members: - -ot.lp ------ -.. automodule:: ot.lp - :members: - -ot.bregman ----------- - -.. automodule:: ot.bregman - :members: - -ot.smooth ------ -.. automodule:: ot.smooth - :members: - -ot.gromov ----------- - -.. automodule:: ot.gromov - :members: - - -ot.optim --------- - -.. automodule:: ot.optim - :members: - -ot.da --------- - -.. automodule:: ot.da - :members: - -ot.gpu --------- - -.. automodule:: ot.gpu - :members: -ot.dr --------- +:py:mod:`ot`: -.. automodule:: ot.dr - :members: - - -ot.utils --------- - -.. automodule:: ot.utils - :members: - -ot.datasets ------------ - -.. automodule:: ot.datasets - :members: - -ot.plot -------- - -.. automodule:: ot.plot - :members: +.. autosummary:: + :toctree: gen_modules/ + :template: module.rst + + lp + bregman + smooth + gromov + optim + da + gpu + dr + utils + datasets + plot + stochastic + unbalanced + partial -ot.stochastic -------------- +.. autosummary:: + :toctree: ../modules/generated/ + :template: module.rst -.. automodule:: ot.stochastic +.. automodule:: ot :members: - -ot.unbalanced -------------- - -.. automodule:: ot.unbalanced - :members: - -ot.partial -------------- - -.. automodule:: ot.partial - :members: - -.. autosummary:: - :toctree: gen_modules/ - :template: module.rst
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index c693a02..1a64d93 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,6 +71,9 @@ extensions = [ 'sphinx_gallery.gen_gallery', ] +autosummary_generate = True + + napoleon_numpy_docstring = True # Add any paths that contain templates here, relative to this directory. |