Merge branch 'pre-release' into 'master'

Fixed sphinx warnings

Documenting and fixing warnings

See merge request !9

bob/bio/face/extractor/GridGraph.py

@@ -36,7 +36,7 @@ class GridGraph (Extractor):
   nodes_between_eyes, nodes_along_eyes, nodes_above_eyes, nodes_below_eyes : int
     Only used when ``eyes`` is not ``None``.
     The number of nodes to be placed between, along, above or below the eyes.
-    The final number of nodes will be: :math:`(above + below + 1) \\times (between + 2*along + 2)`.
+    The final number of nodes will be: `(above + below + 1)` \\times (between + 2*along + 2).
 
   node_distance : (int, int)
     Only used when ``eyes`` is ``None``.

doc/conf.py

@@ -111,7 +111,7 @@ pygments_style = 'sphinx'
 
 # Some variables which are useful for generated material
 project_variable = project.replace('.', '_')
-short_description = u'Run face recognition algorithms'
+short_description = u'Tools for running biometric recognition experiments'
 owner = [u'Idiap Research Institute']
 
 
@@ -216,8 +216,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/extra-intersphinx.txt

+python
+numpy
+bob.bio.base
+bob.io.base
+bob.ip.gabor
+bob.ip.base
+bob.bio.face
+bob.bio.speaker
+bob.bio.gmm
+bob.bio.video
+bob.bio.csu
+bob.bio.spear
+bob.db.lfw
+bob.ip.facedetect
+bob.ip.flandmark
+bob.learn.linear
+gridtk
+bob.db.youtube
\ No newline at end of file

doc/implementation.rst

-
 ======================
 Implementation Details
 ======================
@@ -95,7 +94,7 @@ Databases
 ~~~~~~~~~
 
 One important aspect of :ref:`bob.bio.face <bob.bio.face>` is the relatively large list of supported image data sets, including well-defined evaluation protocols.
-All databases rely on the :py:class:`bob.bio.base.database.DatabaseBob` interface, which in turn uses the :ref:`verification_databases`.
+All databases rely on the :py:class:`bob.bio.base.database.DatabaseBob` interface, which in turn uses the `verification_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
 Please check the link above for information on how to obtain the original data of those data sets.
 
 After downloading and extracting the original data of the data sets, it is necessary that the scripts know, where the data was installed.

doc/index.rst

@@ -37,6 +37,7 @@ Users Guide
 
    baselines
    implementation
+   references
 
 ================
 Reference Manual
@@ -48,6 +49,4 @@ Reference Manual
    implemented
 
 
-.. include:: references.rst
-
 .. todolist::