From 2ac324740e7928b069a86d5bbb89a48e44d8993e Mon Sep 17 00:00:00 2001
From: Pavel Korshunov <pavel.korshunov@idiap.ch>
Date: Thu, 13 Oct 2016 13:44:24 +0200
Subject: [PATCH] [sphinx] Hacked warnings
---
bob/pad/voice/algorithm/__init__.py | 2 ++
bob/pad/voice/extractor/__init__.py | 7 +++++--
bob/pad/voice/extractor/lbp_histograms.py | 2 +-
bob/pad/voice/extractor/vectors_ratios.py | 2 +-
doc/extra-intersphinx.txt | 6 ++++++
doc/index.rst | 15 +++++++++++++++
doc/nitpick-exceptions.txt | 13 +++++++++++++
requirements.txt | 1 +
8 files changed, 44 insertions(+), 4 deletions(-)
create mode 100644 doc/extra-intersphinx.txt
create mode 100644 doc/nitpick-exceptions.txt
diff --git a/bob/pad/voice/algorithm/__init__.py b/bob/pad/voice/algorithm/__init__.py
index 5f6f568..5ec2d72 100644
--- a/bob/pad/voice/algorithm/__init__.py
+++ b/bob/pad/voice/algorithm/__init__.py
@@ -1,3 +1,5 @@
from .gmm_algorithm import GmmAlgorithm
from .logregr_algorithm import LogRegrAlgorithm
+# gets sphinx autodoc done right - don't remove it
+__all__ = [_ for _ in dir() if not _.startswith('_')]
diff --git a/bob/pad/voice/extractor/__init__.py b/bob/pad/voice/extractor/__init__.py
index e66ad59..cc45f19 100644
--- a/bob/pad/voice/extractor/__init__.py
+++ b/bob/pad/voice/extractor/__init__.py
@@ -1,6 +1,9 @@
+from .lbps import LBPs
+from .ratios import Ratios
from .vectors_ratios import VectorsRatios
from .glcms import GLCMs
from .spectrogram_extended import SpectrogramExtended
-from .lbps import LBPs
from .lbp_histograms import LBPHistograms
-from .ratios import Ratios
+
+# gets sphinx autodoc done right - don't remove it
+__all__ = [_ for _ in dir() if not _.startswith('_')]
diff --git a/bob/pad/voice/extractor/lbp_histograms.py b/bob/pad/voice/extractor/lbp_histograms.py
index eb546f0..1a8d614 100644
--- a/bob/pad/voice/extractor/lbp_histograms.py
+++ b/bob/pad/voice/extractor/lbp_histograms.py
@@ -4,7 +4,7 @@ import bob.ip.base
import bob.sp
-from .lbps import LBPs
+from bob.pad.voice.extractor import LBPs
import logging
diff --git a/bob/pad/voice/extractor/vectors_ratios.py b/bob/pad/voice/extractor/vectors_ratios.py
index 14fae21..608cfd5 100644
--- a/bob/pad/voice/extractor/vectors_ratios.py
+++ b/bob/pad/voice/extractor/vectors_ratios.py
@@ -1,6 +1,6 @@
import numpy
-from .ratios import Ratios
+from bob.pad.voice.extractor import Ratios
import math
import logging
diff --git a/doc/extra-intersphinx.txt b/doc/extra-intersphinx.txt
new file mode 100644
index 0000000..4923ead
--- /dev/null
+++ b/doc/extra-intersphinx.txt
@@ -0,0 +1,6 @@
+python
+numpy
+bob.bio.spear
+gridtk
+bob.db.base
+bob.db.avspoof
\ No newline at end of file
diff --git a/doc/index.rst b/doc/index.rst
index 6f20d7b..bf12ed7 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -10,5 +10,20 @@ Presentation Attack Detection in Voice Biometrics
This package is an extension of the ``bob.pad.base`` presentation attack detection (PAD) framework package for voice biometrics.
+==================================
+Tools implemented in bob.pad.voice
+==================================
+Extractors
+----------
+.. automodule:: bob.pad.voice.extractor
+Algorithms
+----------
+
+.. automodule:: bob.pad.voice.algorithm
+
+Databases
+---------
+
+.. automodule:: bob.pad.voice.database
\ No newline at end of file
diff --git a/doc/nitpick-exceptions.txt b/doc/nitpick-exceptions.txt
new file mode 100644
index 0000000..1f44ef7
--- /dev/null
+++ b/doc/nitpick-exceptions.txt
@@ -0,0 +1,13 @@
+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
diff --git a/requirements.txt b/requirements.txt
index 809dcdc..baeeb27 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,3 +5,4 @@ bob.pad.base
bob.bio.spear
bob.bio.gmm
bob.ap
+bob.io.base
\ No newline at end of file
--
GitLab