Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !20

bob/io/image/__init__.py

@@ -20,14 +20,14 @@ def get_config():
   return bob.extension.get_config(__name__, version.externals)
 
 def load(filename, extension=None):
-  """load(filename) -> image
+  """load(filename, extension) -> image
 
   This function loads and image from the file with the specified ``filename``.
   The type of the image will be determined based on the ``extension`` parameter, which can have the following values:
 
   - ``None``: The file name extension of the ``filename`` is used to determine the image type.
-  - ``'auto'``: The type of the image will be detected automatically, using the :py:mod:`imghdr` module.
-  - ``'.xxx`'': The image type is determined by the given extension.
+  - ``'auto'``: The type of the image will be detected automatically, using :py:func:`bob.io.image.get_correct_image_extension`.
+  - ``'.xxx'``: The image type is determined by the given extension.
                 For a list of possible extensions, see :py:func:`bob.io.base.extensions` (only the image extensions are valid here).
 
   **Parameters:**

doc/conf.py

@@ -30,9 +30,29 @@ extensions = [
 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
 
@@ -216,8 +236,13 @@ 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=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/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
 .. _boost: http://www.boost.org
 .. _buildbot: http://trac.buildbot.net
@@ -49,13 +49,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

doc/nitpick-exceptions.txt

+# Documentation for C++ classes is not available yet
+cpp:type std
+cpp:type std::string
+cpp:type blitz
+cpp:type blitz::Array
+cpp:type uint8_t