Commit 84c59c6f authored by Pavel KORSHUNOV's avatar Pavel KORSHUNOV
Browse files

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly

We fix the sphinx issues in next commits

See merge request !7
parents a17dfeb4 c0ce786e
Pipeline #5070 failed with stages
in 22 minutes and 55 seconds
...@@ -30,9 +30,29 @@ extensions = [ ...@@ -30,9 +30,29 @@ extensions = [
import sphinx import sphinx
if sphinx.__version__ >= "1.4.1": if sphinx.__version__ >= "1.4.1":
extensions.append('sphinx.ext.imgmath') extensions.append('sphinx.ext.imgmath')
imgmath_image_format = 'svg'
else: else:
extensions.append('sphinx.ext.pngmath') 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 # Always includes todos
todo_include_todos = True todo_include_todos = True
...@@ -111,7 +131,7 @@ pygments_style = 'sphinx' ...@@ -111,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material # Some variables which are useful for generated material
project_variable = project.replace('.', '_') project_variable = project.replace('.', '_')
short_description = u'Tools for running biometric recognition experiments' short_description = u'Run biometric recognition algorithms on videos'
owner = [u'Idiap Research Institute'] owner = [u'Idiap Research Institute']
...@@ -217,7 +237,7 @@ autodoc_default_flags = [ ...@@ -217,7 +237,7 @@ autodoc_default_flags = [
# For inter-documentation mapping: # For inter-documentation mapping:
from bob.extension.utils import link_documentation, load_requirements from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "./extra-intersphinx.txt" sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements): if os.path.exists(sphinx_requirements):
intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements)) intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements))
else: else:
......
...@@ -53,7 +53,7 @@ Hence, when you want to run an experiment using the video wrapper classes, you m ...@@ -53,7 +53,7 @@ Hence, when you want to run an experiment using the video wrapper classes, you m
Databases Databases
~~~~~~~~~ ~~~~~~~~~
All video databases defined here rely on the :py:class:`bob.bio.db.BioDatabase` interface, which in turn uses the `verification_databases <https://github.com/idiap/bob/wiki/Packages>`_. All video databases defined here rely on the :py:class:`bob.bio.base.BioDatabase` interface, which in turn uses the `verification_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
After downloading and extracting the original data of the data sets, it is necessary that the scripts know, where the data was installed. After downloading and extracting the original data of the data sets, it is necessary that the scripts know, where the data was installed.
For this purpose, the ``./bin/verify.py`` script can read a special file, where those directories are stored, see :ref:`bob.bio.base.installation`. For this purpose, the ``./bin/verify.py`` script can read a special file, where those directories are stored, see :ref:`bob.bio.base.installation`.
......
...@@ -48,7 +48,7 @@ setup( ...@@ -48,7 +48,7 @@ setup(
# #
# Our database packages are good examples of namespace implementations # Our database packages are good examples of namespace implementations
# using several layers. You can check them out here: # using several layers. You can check them out here:
# https://github.com/idiap/bob/wiki/Satellite-Packages # https://gitlab.idiap.ch/bob/bob/wikis/Packages
# This entry defines which scripts you will have inside the 'bin' directory # This entry defines which scripts you will have inside the 'bin' directory
......
Supports Markdown
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