Merge branch 'sphinx-fix' into 'master'

[sphinx] Fixing shortening issue



See merge request !4

bob/pad/voice/extractor/__init__.py

@@ -5,5 +5,12 @@ 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
 __all__ = [_ for _ in dir() if not _.startswith('_')]

doc/conf.py

@@ -243,7 +243,6 @@ if os.path.exists(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
 accepted_private_functions = ['__array__']

doc/nitpick-exceptions.txt

 py:class File
 py:class BioFile
 py:class BioFileSet
-py:class bob.pad.base.database.PadFile
-py:class bob.pad.base.database.file.PadFile
 py:class bob.bio.base.database.database.BioDatabase
-py:class bob.pad.base.database.database.PadDatabase
 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:class bob.pad.voice.extractor.ratios.Ratios
-py:class bob.pad.voice.extractor.lbps.LBPs
-py:class bob.pad.base.algorithm.Algorithm.Algorithm
 py:exc ValueError