[sphinx] Fixing WARNINGS

parent 3269d5d5
Pipeline #4362 passed with stages
in 16 minutes and 20 seconds
......@@ -30,9 +30,29 @@ extensions = [
import sphinx
if sphinx.__version__ >= "1.4.1":
extensions.append('sphinx.ext.imgmath')
imgmath_image_format = 'svg'
else:
extensions.append('sphinx.ext.pngmath')
# 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("#"):
continue
dtype, target = line.split(None, 1)
target = target.strip()
try: # python 2.x
target = unicode(target)
except NameError:
pass
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'YouTube Faces Database Interface for Bob'
short_description = u'Youtube 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))
else:
intersphinx_mapping = link_documentation()
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
......
......@@ -21,7 +21,7 @@ The actual raw data for the `YouTube Faces`_ database should be downloaded from
The Database Interface
----------------------
The :py:class:`bob.db.youtube.Database` complies with the standard biometric verification database as described in :ref:`commons`, implementing the interface :py:class:`bob.db.base.SQLiteDatabase`.
The :py:class:`bob.db.youtube.Database` complies with the standard biometric verification database as described in `bob.db.base <bob.db.base>`, implementing the interface :py:class:`bob.db.base.SQLiteDatabase`.
The Protocols
......@@ -100,7 +100,7 @@ Since the videos are stored as a list of frames, the ``Directory`` interface wil
.. warning::
Please note that -- in opposition to most other bob.db database interfaces -- the :py:meth:`bob.db.youtube.Database.original_file_name` function returns a **list** of file names.
Likewise, :py:meth:`bob.db.youtube.Database.original_file_names` returns a list of lists of file names.
Likewise, :py:meth:`bob.db.youtube.Database.original_file_name` returns a list of lists of file names.
Finally, bounding boxes are annotated in the images.
......
py:class bob.db.base.file.File
py:class bob.db.base.database.SQLiteDatabase
py:class sqlalchemy.ext.declarative.api.Base
py:class bob.db.youtube.models.Directory
py:class File
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment