diff --git a/bob/bio/face/extractor/GridGraph.py b/bob/bio/face/extractor/GridGraph.py index c4a505f33ad4f40d27d3ccdf5757684c1fc88fc8..c1b15ae84778b5008921fd363f8e497f1ddcc7a3 100644 --- a/bob/bio/face/extractor/GridGraph.py +++ b/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``. diff --git a/doc/conf.py b/doc/conf.py index 2728d9ad9316ea153e5164cc8b1b16b477a94cbc..19715ef2194c30dfffa37bae3cd978e07a1fee09 100644 --- a/doc/conf.py +++ b/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 diff --git a/doc/extra-intersphinx.txt b/doc/extra-intersphinx.txt new file mode 100644 index 0000000000000000000000000000000000000000..3e038e4abd5dc97062f78f7f4f871821bf7b6670 --- /dev/null +++ b/doc/extra-intersphinx.txt @@ -0,0 +1,18 @@ +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 diff --git a/doc/implementation.rst b/doc/implementation.rst index 924919b9966362ec970b123c310d95e886bcadc6..186b51c8907e072dd5ad22a284a466a6df4036f4 100644 --- a/doc/implementation.rst +++ b/doc/implementation.rst @@ -1,4 +1,3 @@ - ====================== 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. diff --git a/doc/index.rst b/doc/index.rst index be7e8c2c283f62f1536be514dc500a9f71c2035f..f5fb7ac77b3ad79610642502d9d67111b0bcad96 100644 --- a/doc/index.rst +++ b/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::