Merge pull request #2889 from lamblin/fix_autodoc

doc/conf.py

@@ -17,6 +17,8 @@
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 #sys.path.append(os.path.abspath('some/directory'))
+theano_path = os.path.join(os.path.dirname(__file__), os.pardir)
+sys.path.append(os.path.abspath(theano_path))
 
 # General configuration
 # ---------------------

doc/library/tensor/nnet/neighbours.txt

@@ -10,10 +10,16 @@
 .. moduleauthor:: LISA
 
 
-- Functions
+Functions
+=========
 
-    .. autofunction:: theano.tensor.nnet.neighbours.images2neibs
+.. autofunction:: theano.tensor.nnet.neighbours.images2neibs
 
-    .. autofunction:: theano.tensor.nnet.neighbours.neibs2images
+.. autofunction:: theano.tensor.nnet.neighbours.neibs2images
 
-- See also: :ref:`indexing`, :ref:`lib_scan`
+
+See also
+========
+
+- :ref:`indexing`
+- :ref:`lib_scan`

theano/tensor/nnet/neighbours.py

@@ -455,6 +455,7 @@ def images2neibs(ten4, neib_shape, neib_step=None, mode='valid'):
                       `neib_shape`, some elements are omitted. When None, this
                       is the same as
                       neib_shape(patch are disjoint)
+
                       .. note:: Currently the step size should be chosen in the way that the 
                          corresponding dimension :math:`i` (width or height) is equal to 
                          :math:`n * step\_size_i + neib\_shape_i` for some :math:`n`