diff --git a/bob/db/bio_filelist/query.py b/bob/db/bio_filelist/query.py index ecd95d3b93d96534512d9362c0c4589b7aa9654a..875e7e586b64b776c595e50b6e5f6a65c43a40f4 100644 --- a/bob/db/bio_filelist/query.py +++ b/bob/db/bio_filelist/query.py @@ -759,6 +759,7 @@ class Database(object): This method was imported from the former `bob.db.verification.utils` Keyword parameters: + parameters : str, [str] or None The parameters to be checked. Might be a string, a list/tuple of strings, or None. @@ -770,6 +771,7 @@ class Database(object): default_parameters : [str] or None The list/tuple of default parameters that will be returned in case parameters is None or empty. If omitted, all valid_parameters are used. + """ if parameters is None: # parameters are not specified, i.e., 'None' or empty lists diff --git a/develop.cfg b/develop.cfg index 29c3ae0ff15d84aeef35be21306b9b53c7696fd4..5ed81bd039209babc770264394beb785f2df54aa 100644 --- a/develop.cfg +++ b/develop.cfg @@ -22,7 +22,7 @@ verbose = true newest = false [sources] -bob.db.base = git https://gitlab.idiap.ch/bob/bob.db.base branch=refactoring_2016 +bob.db.base = git https://gitlab.idiap.ch/bob/bob.db.base bob.extension = git https://gitlab.idiap.ch/bob/bob.extension bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz bob.core = git https://gitlab.idiap.ch/bob/bob.core diff --git a/doc/conf.py b/doc/conf.py index ab4047a8b6a4c788a770dc95e1d69188afe49ed1..5173ee0f0cff550ed7a071f353e9c55a2468c21b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 @@ -237,4 +242,4 @@ def member_function_test(app, what, name, obj, skip, options): return False def setup(app): - app.connect('autodoc-skip-member', member_function_test) \ No newline at end of file + app.connect('autodoc-skip-member', member_function_test) diff --git a/doc/extra-intersphinx.txt b/doc/extra-intersphinx.txt new file mode 100644 index 0000000000000000000000000000000000000000..11ceb0a31c3c1253fe6abef26a66311b092b4689 --- /dev/null +++ b/doc/extra-intersphinx.txt @@ -0,0 +1,3 @@ +python +numpy +bob.bio.base \ No newline at end of file diff --git a/doc/guide.rst b/doc/guide.rst index e3847c6bb8d0839070d4ac43f6817558ba38659f..95cc4642d302fbdabdacd37573326b0285cec287 100644 --- a/doc/guide.rst +++ b/doc/guide.rst @@ -9,7 +9,7 @@ The Database Interface ---------------------- -The :py:class:`bob.db.bio_filelist.Database` complies with the standard biometric verification database as described in :ref:`commons`. +The :py:class:`bob.db.bio_filelist.Database` complies with the standard biometric verification database as described in :ref:`bob.bio.base`. All functions defined in that interface are properly instantiated, as soon as the user provides the required file lists. Creating File Lists diff --git a/doc/index.rst b/doc/index.rst index af216a2dea6afb11d4762b0e8649091766515042..6aede0d69f40912ce334468e4545a4292aa06333 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -2,7 +2,7 @@ .. @author: Manuel Guenther <Manuel.Guenther@idiap.ch> .. @date: Tue Aug 26 09:42:18 CEST 2014 -.. _bob.db.bob.db.bio_filelist +.. _bob.db.bob.db.bio_filelist: ======================================== Verification Protocol using File Lists