From e9514dcb535f2c21270cbc3a600762fe1fa45b9b Mon Sep 17 00:00:00 2001
From: Pavel Korshunov <pavel.korshunov@idiap.ch>
Date: Wed, 19 Oct 2016 20:17:30 +0200
Subject: [PATCH] [sphinx] Fixd module shortening, removed ref to bob.pad.voice
---
bob/pad/base/algorithm/__init__.py | 2 ++
bob/pad/base/database/__init__.py | 4 ++--
doc/extra-intersphinx.txt | 3 +--
doc/implementation.rst | 2 +-
doc/installation.rst | 2 +-
5 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/bob/pad/base/algorithm/__init__.py b/bob/pad/base/algorithm/__init__.py
index 64da3be..e0721d1 100644
--- a/bob/pad/base/algorithm/__init__.py
+++ b/bob/pad/base/algorithm/__init__.py
@@ -1,4 +1,6 @@
from .Algorithm import Algorithm
+# to fix sphinx warnings of not able to find classes, when path is shortened
+Algorithm.__module__ = "bob.pad.base.algorithm"
# gets sphinx autodoc done right - don't remove it
__all__ = [_ for _ in dir() if not _.startswith('_')]
diff --git a/bob/pad/base/database/__init__.py b/bob/pad/base/database/__init__.py
index cc025f5..b310f8a 100644
--- a/bob/pad/base/database/__init__.py
+++ b/bob/pad/base/database/__init__.py
@@ -2,7 +2,7 @@ from .database import PadDatabase
from .file import PadFile
# to fix sphinx warnings of not able to find classes, when path is shortened
-PadDatabase.__module__ = "database"
-PadFile.__module__ = "database"
+PadDatabase.__module__ = "bob.pad.base.database"
+PadFile.__module__ = "bob.pad.base.database"
# gets sphinx autodoc done right - don't remove it
__all__ = [_ for _ in dir() if not _.startswith('_')]
diff --git a/doc/extra-intersphinx.txt b/doc/extra-intersphinx.txt
index 084964f..4923ead 100644
--- a/doc/extra-intersphinx.txt
+++ b/doc/extra-intersphinx.txt
@@ -3,5 +3,4 @@ numpy
bob.bio.spear
gridtk
bob.db.base
-bob.db.avspoof
-bob.pad.voice
\ No newline at end of file
+bob.db.avspoof
\ No newline at end of file
diff --git a/doc/implementation.rst b/doc/implementation.rst
index 1e487a3..155ea12 100644
--- a/doc/implementation.rst
+++ b/doc/implementation.rst
@@ -93,7 +93,7 @@ Implemented Tools
Example implementations of the base classes can be found in all of the ``bob.pad`` packages.
Here is the current list of implementations:
-* :ref:`bob.pad.voice <bob.pad.voice>` : :ref:`bob.pad.voice`
+* `bob.pad.voice`
.. todo:: complete this list, once the other packages are documented as well.
diff --git a/doc/installation.rst b/doc/installation.rst
index a358a40..91816a0 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -63,7 +63,7 @@ Please use ``./bin/databases.py`` for a list of known databases, where you can s
.. note::
- If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as :ref:`bob.pad.voice <bob.pad.voice>`.
+ If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as `bob.pad.voice`.
Test your Installation
--
GitLab