diff --git a/doc/conf.py b/doc/conf.py index 19715ef2194c30dfffa37bae3cd978e07a1fee09..c6039bf36fde83333b399a7eefb92b403ffbc536 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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'Tools for running biometric recognition experiments' +short_description = u'Tools for running face recognition experiments' owner = [u'Idiap Research Institute'] @@ -217,7 +237,7 @@ autodoc_default_flags = [ # For inter-documentation mapping: 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): intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements)) else: