Cleaned sphinx exceptions fixed in bob.bio.base

bob/pad/voice/algorithm/__init__.py

@@ -6,4 +6,21 @@ GmmAlgorithm.__module__ = "bob.pad.voice.algorithm"
 LogRegrAlgorithm.__module__ = "bob.pad.voice.algorithm"
 
 # 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__(
+    GmmAlgorithm,
+    LogRegrAlgorithm,
+    )
 __all__ = [_ for _ in dir() if not _.startswith('_')]

bob/pad/voice/database/__init__.py

@@ -5,13 +5,26 @@ from .replay import ReplayPadDatabase
 from .replaymobile import ReplayMobilePadDatabase
 from .voicepa import VoicePAPadDatabase
 
-# to fix sphinx warnings of not able to find classes, when path is shortened
-PadVoiceFile.__module__ = "bob.pad.voice.database"
-ASVspoofPadDatabase.__module__ = "bob.pad.voice.database"
-AVspoofPadDatabase.__module__ = "bob.pad.voice.database"
-ReplayPadDatabase.__module__ = "bob.pad.voice.database"
-ReplayMobilePadDatabase.__module__ = "bob.pad.voice.database"
-VoicePAPadDatabase.__module__ = "bob.pad.voice.database"
-
 # 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__(
+    PadVoiceFile,
+    ASVspoofPadDatabase,
+    AVspoofPadDatabase,
+    ReplayPadDatabase,
+    ReplayMobilePadDatabase,
+    VoicePAPadDatabase,
+    )
 __all__ = [_ for _ in dir() if not _.startswith('_')]

bob/pad/voice/extractor/__init__.py

@@ -5,12 +5,26 @@ from .glcms import GLCMs
 from .spectrogram_extended import SpectrogramExtended
 from .lbp_histograms import LBPHistograms
 
-# to fix sphinx warnings of not able to find classes, when path is shortened
-Ratios.__module__ = "bob.pad.voice.extractor"
-LBPs.__module__ = "bob.pad.voice.extractor"
-VectorsRatios.__module__ = "bob.pad.voice.extractor"
-GLCMs.__module__ = "bob.pad.voice.extractor"
-SpectrogramExtended.__module__ = "bob.pad.voice.extractor"
-LBPHistograms.__module__ = "bob.pad.voice.extractor"
 # 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__(
+    Ratios,
+    LBPs,
+    VectorsRatios,
+    GLCMs,
+    SpectrogramExtended,
+    LBPHistograms,
+    )
 __all__ = [_ for _ in dir() if not _.startswith('_')]

doc/nitpick-exceptions.txt

-py:class File
-py:class BioFile
-py:class BioFileSet
-py:class bob.bio.base.database.database.BioDatabase
-py:class bob.bio.base.preprocessor.Preprocessor.Preprocessor
-py:class bob.bio.base.extractor.Extractor.Extractor
-py:class bob.bio.base.database.file.BioFile
 py:exc ValueError