Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
53265db
build wheels on push to master
rflamary Apr 24, 2020
8599e72
correct doc for emd
rflamary Apr 24, 2020
6931f78
better documentation
rflamary Apr 24, 2020
a5b1b18
add ferradans to da classes documentation
rflamary Apr 24, 2020
bed1680
pep8
rflamary Apr 24, 2020
c529ffd
update doc
rflamary Apr 24, 2020
46523dc
add realeases
rflamary Apr 24, 2020
53b063e
better coverage options verbose and log
rflamary Apr 24, 2020
c3115bc
mockj module cupy for gpu focumentation
rflamary Apr 24, 2020
90bd408
pep8
rflamary Apr 24, 2020
17d388b
test raise un partial ot
rflamary Apr 24, 2020
eb3a70a
left some unused variable...
rflamary Apr 24, 2020
6b42088
better documentation
rflamary Apr 24, 2020
2b43492
test options sphinx gallery
rflamary Apr 24, 2020
0d13d60
Better section name + snhix-gallery tuning
rflamary Apr 24, 2020
99e6d91
Better section name + snhix-gallery tuning
rflamary Apr 24, 2020
fe704c3
test autosummary
rflamary Apr 24, 2020
1a3249d
awesome mini gallery
rflamary Apr 24, 2020
b9ad0ee
add template
rflamary Apr 24, 2020
ad7aa89
better doc per module
rflamary Apr 24, 2020
08ec66e
pep8
rflamary Apr 24, 2020
576c3d5
better thumbnail image for gallery
rflamary Apr 24, 2020
e18e18f
test new foldeer
rflamary Apr 24, 2020
a547751
exmaples in sections
rflamary Apr 24, 2020
4bbabc6
relative path exmaples
rflamary Apr 24, 2020
956df7a
vchange path in examples
rflamary Apr 24, 2020
71e7984
update proper links form readme
rflamary Apr 24, 2020
3b0732b
correct url for examples
rflamary Apr 27, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
awesome mini gallery
  • Loading branch information
rflamary committed Apr 24, 2020
commit 1a3249dd6d6971de23534b797ce81fd670befa2b
111 changes: 24 additions & 87 deletions docs/source/all.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 3 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ def __getattr__(cls, name):
'sphinx_gallery.gen_gallery',
]

autosummary_generate = True


napoleon_numpy_docstring = True

# Add any paths that contain templates here, relative to this directory.
Expand Down