[sphinx] just make sure everything is green for now

bob/pad/base/database/__init__.py

@@ -6,26 +6,21 @@ from .PadBioFileDB import HighBioDatabase, HighPadDatabase
 
 # gets sphinx autodoc done right - don't remove it
 def __appropriate__(*args):
-  """Says object was actually declared here, and not in the import module.
-  Fixing sphinx warnings of not being able to find classes, when path is shortened.
-  Parameters:
+    """Says object was actually declared here, and not in the import module.
+    Fixing sphinx warnings of not being able to find classes, when path is shortened.
+    Parameters:
 
-    *args: An iterable of objects to modify
+      *args: An iterable of objects to modify
 
-  Resolves `Sphinx referencing issues
-  <https://github.com/sphinx-doc/sphinx/issues/3048>`
-  """
+    Resolves `Sphinx referencing issues
+    <https://github.com/sphinx-doc/sphinx/issues/3048>`
+    """
 
-  for obj in args:
-    obj.__module__ = __name__
+    for obj in args:
+        obj.__module__ = __name__
 
 
 __appropriate__(
-    PadFile,
-    PadDatabase,
-    FileListPadDatabase,
-    Client,
-    HighBioDatabase,
-    HighPadDatabase
+    PadFile, PadDatabase, FileListPadDatabase, Client, HighBioDatabase, HighPadDatabase
 )
-__all__ = [_ for _ in dir() if not _.startswith('_')]
+__all__ = [_ for _ in dir() if not _.startswith("_")]

bob/pad/base/pipelines/vanilla_pad/__init__.py

 from .abstract_classes import Database
 from .legacy import DatabaseConnector
+
+# gets sphinx autodoc done right - don't remove it
+def __appropriate__(*args):
+    """Says object was actually declared here, and not in the import module.
+    Fixing sphinx warnings of not being able to find classes, when path is shortened.
+    Parameters:
+
+      *args: An iterable of objects to modify
+
+    Resolves `Sphinx referencing issues
+    <https://github.com/sphinx-doc/sphinx/issues/3048>`
+    """
+
+    for obj in args:
+        obj.__module__ = __name__
+
+
+__appropriate__(
+    Database,
+    DatabaseConnector,
+)
+__all__ = [_ for _ in dir() if not _.startswith("_")]

doc/experiments.rst

@@ -63,7 +63,7 @@ These five options are:
 * ``--sub-directory``: A descriptive name for your experiment, which will serve as a sub-directory
 
 The first four parameters, i.e., the ``database``, the ``preprocessor``, the ``extractor`` and the ``algorithm`` can be specified in several different ways.
-For the start, we will use only the registered :ref:`Resources <bob.bio.base.resources>`.
+For the start, we will use only the registered Resources.
 These resources define the source code that will be used to compute the experiments, as well as all the meta-parameters of the algorithms (which we will call the *configuration*).
 To get a list of registered resources, please call:
 
@@ -112,7 +112,7 @@ After the experiment has finished successfully, one or more text file containing
 all the scores are written. In this section, commands that helps to quickly
 evaluate a set of scores by generating metrics or plots are presented here.
 The scripts take as input either a 4-column or 5-column data format as specified
-in the documentation of :py:func:`bob.bio.base.score.load.four_column` or 
+in the documentation of :py:func:`bob.bio.base.score.load.four_column` or
 :py:func:`bob.bio.base.score.load.five_column`.
 
 Two sets of commands, ``bob pad`` and ``bob vuln`` are available for

doc/implemented.rst

@@ -15,14 +15,12 @@ Base Classes
 Most of the base classes are reused from :ref:`bob.bio.base <bob.bio.base>`.
 Only one base class that is presentation attack detection specific, ``Algorithm`` is implemented in this package.
 
-.. autosummary::
-   bob.pad.base.algorithm.Algorithm
-   bob.pad.base.algorithm.Predictions
-
 Implementations
 ~~~~~~~~~~~~~~~
 
 .. autosummary::
+   bob.pad.base.pipelines.vanilla_pad.Database
+   bob.pad.base.pipelines.vanilla_pad.DatabaseConnector
    bob.pad.base.database.PadDatabase
    bob.pad.base.database.PadFile
 
@@ -30,13 +28,7 @@ Preprocessors and Extractors
 ----------------------------
 
 Preprocessors and Extractors from the :ref:`bob.bio.base <bob.bio.base>`
-package can also be used in this package. Please see
-:any:`bob.bio.base.implemented` for more details.
-
-Algorithms
-----------
-
-.. automodule:: bob.pad.base.algorithm
+package can also be used in this package.
 
 
 Databases

doc/installation.rst

@@ -42,7 +42,7 @@ command line below will install all the required packages:
 
 .. code-block:: sh
 
-    $ source activate <bob_conda_environment>
+    $ conda activate <bob_conda_environment>
     $ conda install bob.bio.base \
                     bob.bio.spear \
                     bob.pad.base \

doc/py_api.rst

@@ -12,29 +12,6 @@ Generic functions
 Tools to run PAD experiments
 ----------------------------
 
-Command line generation
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autosummary::
-   bob.pad.base.tools.command_line_parser
-   bob.pad.base.tools.initialize
-   bob.pad.base.tools.command_line
-   bob.pad.base.tools.write_info
-   bob.pad.base.tools.FileSelector
-
-Algorithm
-~~~~~~~~~
-
-.. autosummary::
-   bob.pad.base.tools.train_projector
-   bob.pad.base.tools.project
-   bob.pad.base.algorithm
-
-Scoring
-~~~~~~~
-
-.. autosummary::
-   bob.bio.base.tools.compute_scores
 
 Details
 -------
@@ -42,9 +19,5 @@ Details
 .. automodule:: bob.pad.base
 
 
-.. automodule:: bob.pad.base.tools
-
-   .. autoclass:: FileSelector
-
 
 .. include:: links.rst