Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !1

doc/conf.py

@@ -25,14 +25,35 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
+    #'matplotlib.sphinxext.plot_directive'
     ]
 
 import sphinx
 if sphinx.__version__ >= "1.4.1":
     extensions.append('sphinx.ext.imgmath')
+    imgmath_image_format = 'svg'
 else:
     extensions.append('sphinx.ext.pngmath')
 
+# Be picky about warnings
+nitpicky = True
+
+# Ignores stuff we can't easily resolve on other project's sphinx manuals
+nitpick_ignore = []
+
+# Allows the user to override warnings from a separate file
+if os.path.exists('nitpick-exceptions.txt'):
+    for line in open('nitpick-exceptions.txt'):
+        if line.strip() == "" or line.startswith("#"):
+            continue
+        dtype, target = line.split(None, 1)
+        target = target.strip()
+        try: # python 2.x
+            target = unicode(target)
+        except NameError:
+            pass
+        nitpick_ignore.append((dtype, target))
+
 # Always includes todos
 todo_include_todos = True
 
@@ -111,7 +132,7 @@ pygments_style = 'sphinx'
 
 # Some variables which are useful for generated material
 project_variable = project.replace('.', '_')
-short_description = u"Ce Liu's Optical Flow Framework for Bob"
+short_description = u'Ce Liu\'s Optical Flow Framework for Bob'
 owner = [u'Idiap Research Institute']
 
 
@@ -216,8 +237,16 @@ autodoc_default_flags = [
   ]
 
 # For inter-documentation mapping:
-from bob.extension.utils import link_documentation
-intersphinx_mapping = link_documentation()
+from bob.extension.utils import link_documentation, load_requirements
+sphinx_requirements = "extra-intersphinx.txt"
+if os.path.exists(sphinx_requirements):
+  intersphinx_mapping = link_documentation(
+      additional_packages=['python','numpy'] + \
+          load_requirements(sphinx_requirements)
+          )
+else:
+  intersphinx_mapping = link_documentation()
+
 
 # We want to remove all private (i.e. _. or __.__) members
 # that are not in the list of accepted functions

doc/extra-intersphinx.txt

+bob.io.matlab

doc/guide.rst

@@ -74,9 +74,13 @@ I have detected inconsistencies between output produced by these pythonic bindin
 In all instances, these differences come from differences in either the gray-scaling conversion and/or the decompression routines for the test images and movies.
 Once a precise input is given in double-precision gray-scale, both bindings (ours and Ce Liu's Matlab ones) give out **exactly** the same output.
 
-This means that you should expect precision problems if you feed in videos or lossy input formats such as JPEG images.
-If you input HDF5 files (e.g. using :ref:`bob.io.base <bob.io.base>`), Matlab ``.mat`` files (e.g. using :ref:`bob.io.matlab <bob.io.matlab>`) or any other data in formats which are **not** subject to lossy
-compression/decompression, this data is pre-grayscaled **and** stored in double-precision floating point numbers, the output is consistently the same, no matter which environment you use.
+This means that you should expect precision problems if you feed in videos or
+lossy input formats such as JPEG images.  If you input HDF5 files (e.g. using
+:py:mod:`bob.io.base`), Matlab ``.mat`` files (e.g. using
+:py:mod:`bob.io.matlab`) or any other data in formats which are **not** subject
+to lossy compression/decompression, this data is pre-grayscaled **and** stored
+in double-precision floating point numbers, the output is consistently the
+same, no matter which environment you use.
 
 If you input data which is not double-precision gray-scale, then it is (1) converted to double-precision representation and then (2) gray-scaled.
 These steps are taken in this order in both bindings.
@@ -93,12 +97,15 @@ The new framework is presumably faster, but does not give similar results compar
 If you would like to give it a spin, use the method :py:func:`bob.ip.optflow.liu.sor.flow` instead of py:func:`bob.ip.optflow.liu.cg.flow` as shown above.
 Notice that the defaults for both implementations are different, following the defaults pre-set in the Matlab MEX code in the different releases.
 
-Particularly, avoid feeding colored images to :py:func:`bob.ip.optflow.liu.sor.flow`.
-While that works OK with :py:func:`bob.ip.opflow.liu.cg.flow`, :py:func:`bob.ip.opflow.liu.cg.sor.flow` gives inconsistent results everytime it is run.
-I recommend gray-scaling images before using :py:func:`bob.ip.opflow.liu.cg.sor.flow`, e.g., by converting them using :py:func:`bob.ip.color.rgb_to_gray`.
-With that, results are at least consistent between runs.
-I'm not sure about their correctness.
-Ce Liu has been informed and should be working on it soon enough (today is 14.Nov.2012).
+Particularly, avoid feeding colored images to
+:py:func:`bob.ip.optflow.liu.sor.flow`.  While that works OK with
+:py:func:`bob.ip.optflow.liu.cg.flow`, :py:func:`bob.ip.optflow.liu.sor.flow`
+gives inconsistent results everytime it is run. I recommend gray-scaling
+images before using :py:func:`bob.ip.optflow.liu.sor.flow`, e.g., by
+converting them using :py:func:`bob.ip.color.rgb_to_gray`. With that, results
+are at least consistent between runs.  I'm not sure about their correctness.
+Ce Liu has been informed and should be working on it soon enough (today is
+14.Nov.2012).
 
 To access this implementation, use :py:func:`bob.ip.optflow.liu.sor.flow`.
 

doc/links.rst

@@ -10,7 +10,7 @@
 
 .. _argparse: http://code.google.com/p/argparse/
 .. _blitz++: http://www.oonumerics.org/blitz
-.. _bob's idiap guide: http://github.com/idiap/bob/wiki/Using-Bob-at-Idiap
+.. _bob's idiap guide: https://gitlab.idiap.ch/bob/bob/wikis/Using-Bob-at-Idiap
 .. _bob's website: https://www.idiap.ch/software/bob
 .. _bob: https://www.idiap.ch/software/bob
 .. _boost: http://www.boost.org
@@ -51,13 +51,13 @@
 .. _python: http://www.python.org
 .. _pypi: http://pypi.python.org
 .. _qt4: http://qt.nokia.com/
-.. _satellite packages: https://github.com/idiap/bob/wiki/Satellite-Packages
+.. _satellite packages: https://gitlab.idiap.ch/bob/bob/wikis/Packages
 .. _scipy: http://www.scipy.org
 .. _setuptools: http://trac.edgewall.org/wiki/setuptools
 .. _sphinx: http://sphinx.pocoo.org
 .. _sqlalchemy: http://www.sqlalchemy.org/
 .. _sqlite: http://www.sqlite.org/
-.. _submit a new bug report: https://github.com/idiap/bob/issues
+.. _submit a new bug report: https://groups.google.com/forum/?fromgroups#!forum/bob-devel
 .. _torch 3 vision: http://torch3vision.idiap.ch
 .. _torch 3: http://www.torch.ch
 .. _torch 5: http://torch5.sourceforge.net