improve docs

MANIFEST.in

 include README.rst bootstrap-buildout.py buildout.cfg COPYING version.txt requirements.txt
 recursive-include doc *.py *.rst *.ico *.png
+recursive-include bob/pad/face/test/data *.hdf5

bob/pad/face/extractor/LBPHistogram.py

@@ -7,7 +7,7 @@ import numpy
 
 class LBPHistogram(Extractor):
     """Calculates a normalized LBP histogram over an image.
-    These features are implemented based on the chingovska_effectiveness_2012_.
+    These features are implemented based on [ChingovskaEffectivnes12]_.
 
     Parameters
     ----------
@@ -32,13 +32,6 @@ class LBPHistogram(Extractor):
         resulting features have that dtype.
     lbp : bob.ip.base.LBP
         The LPB extractor object.
-
-
-    .. _chingovska_effectiveness_2012:
-        I. Chingovska, A. Anjos, and S. Marcel, ``On the effectiveness of
-        local binary patterns in face anti-spoofing,'' in Biometrics Special
-        Interest Group (BIOSIG), 2012 BIOSIG-Proceedings of the International
-        Conference of the, 2012, pp. 1-7.
     """
 
     def __init__(self,
@@ -130,10 +123,3 @@ class LBPHistogram(Extractor):
         if self.dtype is not None:
             hist = hist.astype(self.dtype)
         return hist
-
-    # re-define unused functions, just so that they do not get documented
-    def train(*args, **kwargs):
-        raise NotImplementedError()
-
-    def load(*args, **kwargs):
-        pass

doc/conf.py

@@ -232,7 +232,6 @@ autodoc_member_order = 'bysource'
 autodoc_default_flags = [
   'members',
   'undoc-members',
-  'inherited-members',
   'show-inheritance',
   ]
 

doc/index.rst

@@ -15,6 +15,7 @@ Package Documentation
    :maxdepth: 2
 
    guide
+   refrences
    py_api
 
 

doc/py_api.rst

@@ -19,9 +19,6 @@ Video Preprocessors
 Image Extractors
 ~~~~~~~~~~~~~~~~
 
-Image Extractors
-~~~~~~~~~~~~~~~~
-
 .. autosummary::
 
 	bob.pad.face.extractor.LBPHistogram
@@ -37,4 +34,5 @@ Image Extractors
 ----------------
 
 .. automodule:: bob.pad.face.extractor
-
+	:special-members: __call__
+	:no-inherited-members:

doc/refrences.rst

+.. vim: set fileencoding=utf-8 :
+
+==========
+References
+==========
+
+.. [ChingovskaEffectivnes12]  I. Chingovska, A. Anjos, and S. Marcel, ''On the
+	effectiveness of local binary patterns in face anti- spoofing,'' in
+	Biometrics Special Interest Group (BIOSIG), 2012 BIOSIG- Proceedings of the
+	International Conference of the, 2012, pp. 1-7.