Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !2

bob/ip/draw/main.cpp

@@ -21,7 +21,7 @@ static bob::extension::FunctionDoc s_point = bob::extension::FunctionDoc(
     "This method can draw a point in either gray-scale (2D) or color images. "
     "Images have to be :py:class:`numpy.ndarray`'s with either ``uint8``, "
     "``uint16`` or ``float64`` data type. Trying to access outside the image "
-    "range will raise a :py:class:`RuntimeError`.\n"
+    "range will raise a :py:exc:`RuntimeError`.\n"
     "\n"
     "In case you pass a 2D array representing a gray-scale image, this function "
     "expects you pass a single scalar as a value for the input parameter "
@@ -100,7 +100,7 @@ static bob::extension::FunctionDoc s_cross = bob::extension::FunctionDoc(
     "point ``p`` and will have the ``radius`` defined. Images have to be "
     ":py:class:`numpy.ndarray`'s with either ``uint8``, ``uint16`` or "
     "``float64`` data type. Trying to access outside the image range will "
-    "raise a :py:class:`RuntimeError`.\n"
+    "raise a :py:exc:`RuntimeError`.\n"
     "\n"
     "In case you pass a 2D array representing a gray-scale image, this function "
     "expects you pass a single scalar as a value for the input parameter "
@@ -130,7 +130,7 @@ static bob::extension::FunctionDoc s_plus = bob::extension::FunctionDoc(
     "point ``p`` and will have the ``radius`` defined. Images have to be "
     ":py:class:`numpy.ndarray`'s with either ``uint8``, ``uint16`` or "
     "``float64`` data type. Trying to access outside the image range will "
-    "raise a :py:class:`RuntimeError`.\n"
+    "raise a :py:exc:`RuntimeError`.\n"
     "\n"
     "In case you pass a 2D array representing a gray-scale image, this function "
     "expects you pass a single scalar as a value for the input parameter "

develop.cfg

@@ -18,8 +18,8 @@ verbose = true
 newest = false
 
 [sources]
-bob.extension = git git@gitlab.idiap.ch:bob/bob.extension
-bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz
+bob.extension = git https://gitlab.idiap.ch/bob/bob.extension
+bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz
 
 [scripts]
 recipe = bob.buildout:scripts

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/nitpick-exceptions.txt

+# Not properly documented on Python 2.7 manual
+py:exc RuntimeError