[sphinx] Fixed warnings

parent 4407b58c
Pipeline #4337 passed with stages
in 21 minutes and 16 seconds
......@@ -55,11 +55,13 @@ class Database(bob.db.base.SQLiteDatabase):
def original_file_name(self, file, check_existence = True):
"""This function returns the original file name for the given File object.
Keyword parameters:
file : :py:class:`File` or a derivative
The File objects for which the file name should be retrieved
check_existence : bool
Check if the original file exists? IGNORED: ALWAYS CHECK
Return value : str
Return value:
The original file name for the given File object
......@@ -93,8 +95,10 @@ class Database(bob.db.base.SQLiteDatabase):
def annotations(self, file, annotation_type="eyes_center"):
"""This function returns the annotations for the given file id as a dictionary.
Keyword parameters:
file : :py:class:`bob.db.base.File` or one of its derivatives
The File object you want to retrieve the annotations for,
Return value:
A dictionary of annotations, for face images usually something like {'leye':(le_y,le_x), 'reye':(re_y,re_x), ...},
or None if there are no annotations for the given file ID (which is the case in this base class implementation).
......@@ -30,9 +30,29 @@ extensions = [
import sphinx
if sphinx.__version__ >= "1.4.1":
imgmath_image_format = 'svg'
# Be picky about warnings
nitpicky = True
# Ignores stuff we can't easily resolve on other project's sphinx manuals
nitpick_ignore = []
# Allows the user to override warnings from a separate file
if os.path.exists('nitpick-exceptions.txt'):
for line in open('nitpick-exceptions.txt'):
if line.strip() == "" or line.startswith("#"):
dtype, target = line.split(None, 1)
target = target.strip()
try: # python 2.x
target = unicode(target)
except NameError:
nitpick_ignore.append((dtype, target))
# Always includes todos
todo_include_todos = True
......@@ -111,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'CUHK Face Sketch Database (CUFS)'
short_description = u'CUFS Database API'
owner = [u'Idiap Research Institute']
......@@ -216,8 +236,13 @@ autodoc_default_flags = [
# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation()
from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements))
intersphinx_mapping = link_documentation()
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
......@@ -13,7 +13,7 @@ The actual raw data for the database should be downloaded from the original URL.
The Database Interface
The :py:class:`bob.db.cuhk_cufs.Database` complies with the standard biometric verification database as described in :ref:`commons`, implementing both interfaces :py:class:`bob.db.base.SQLiteDatabase`.
The :py:class:`bob.db.cuhk_cufs.Database` complies with the standard biometric verification database as described in `bob.db.base <bob.db.base>`, implementing both interfaces :py:class:`bob.db.base.SQLiteDatabase`.
CUHK CUFS Protocols
py:class bob.db.base.file.File
py:class bob.db.base.database.SQLiteDatabase
py:class sqlalchemy.ext.declarative.api.Base
......@@ -31,7 +31,7 @@ setup(
description='CUHK Face Sketch Database (CUFS)',
keywords = "",
author='Tiago de Freitas Pereira',
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment