working doc with gallery

Author: rflamary

docs/source/conf.py

@@ -17,23 +17,23 @@
 import re
 import sphinx_gallery
 
-#try:
-from unittest.mock import MagicMock
-#except ImportError:
-#    from mock import MagicMock
-
-sys.path.insert(0, os.path.abspath("../.."))
-#sys.setrecursionlimit(1500)
-
-
-
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-        return Mock()
-
-MOCK_MODULES = [ 'emd','ot.lp.emd']
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+##try:
+#from unittest.mock import MagicMock
+##except ImportError:
+##    from mock import MagicMock
+#
+#sys.path.insert(0, os.path.abspath("../.."))
+##sys.setrecursionlimit(1500)
+#
+#
+#
+#class Mock(MagicMock):
+#    @classmethod
+#    def __getattr__(cls, name):
+#        return Mock()
+#
+#MOCK_MODULES = [ 'emd','ot.lp.emd']
+#sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -58,7 +58,7 @@ def __getattr__(cls, name):
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
-#    'sphinx_gallery.gen_gallery',
+    'sphinx_gallery.gen_gallery',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -324,6 +324,7 @@ def __getattr__(cls, name):
 sphinx_gallery_conf = {
     'examples_dirs': '../../examples',
     'gallery_dirs': 'auto_examples',
+    'mod_example_dir': '../modules/generated/',
     'reference_url': {
         'numpy': 'http://docs.scipy.org/doc/numpy-1.9.1',
         'scipy': 'http://docs.scipy.org/doc/scipy-0.17.0/reference'}

docs/source/index.rst

@@ -10,11 +10,11 @@ Contents
 --------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    self
    all
-   auto_examples
+   auto_examples/index
 
 .. include:: readme.rst
     :start-line: 5

examples/README.txt

@@ -1,3 +1,2 @@
-============
 POT Examples
 ============

examples/plot_OTDA_2D.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-===============================================
-demo of Optimal transport for domain adaptation
-===============================================
+==============================
+OT for empirical distributions
+==============================
 
 """
 

examples/plot_OTDA_classes.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-===============================================
-demo of Optimal transport for domain adaptation
-===============================================
+========================
+OT for domain adaptation
+========================
 
 """
 

examples/plot_OTDA_color_images.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-=====================================================================================
-Demo of Optimal transport for domain adaptation with image color adaptation as in [6]
-=====================================================================================
+========================================================
+OT for domain adaptation with image color adaptation [6]
+========================================================
 
 [6] Ferradans, S., Papadakis, N., Peyre, G., & Aujol, J. F. (2014). Regularized discrete optimal transport. SIAM Journal on Imaging Sciences, 7(3), 1853-1882.
 """

examples/plot_OTDA_mapping.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-=======================================================
-Demo of OT mapping estimation for domain adaptation [8]
-=======================================================
+===============================================
+OT mapping estimation for domain adaptation [8]
+===============================================
 
 [8] M. Perrot, N. Courty, R. Flamary, A. Habrard, "Mapping estimation for
     discrete optimal transport", Neural Information Processing Systems (NIPS), 2016.

examples/plot_OTDA_mapping_color_images.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-======================================================================================================================
-Demo of Optimal transport for domain adaptation with image color adaptation as in [6] with mapping estimation from [8]
-======================================================================================================================
+====================================================================================
+OT for domain adaptation with image color adaptation [6] with mapping estimation [8]
+====================================================================================
 
 [6] Ferradans, S., Papadakis, N., Peyre, G., & Aujol, J. F. (2014). Regularized
     discrete optimal transport. SIAM Journal on Imaging Sciences, 7(3), 1853-1882.

examples/plot_OT_1D.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-=============================
-Demo for 1D optimal transport
-=============================
+====================
+1D optimal transport
+====================
 
 @author: rflamary
 """

examples/plot_OT_2D_samples.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-=============================================================
-Demo for 2D Optimal transport between empirical distributions
-=============================================================
+====================================================
+2D Optimal transport between empirical distributions
+====================================================
 
 @author: rflamary
 """