diff --git a/doc/conf.py b/doc/conf.py index 844307fb346a7e1599de6858ca6702f4bb59b076..39120fc21288f402af36bfab544d5be29bd84b68 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 biometric recognition experiments using GMM-based approximation' 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: diff --git a/setup.py b/setup.py index 9f0e8bf870358bb4903293cbfbef5e231f6b360b..48484d00a4af0486bd38df1e40191c0398fe46e1 100644 --- a/setup.py +++ b/setup.py @@ -49,7 +49,7 @@ setup( version = open("version.txt").read().rstrip(), description = 'Tools for running biometric recognition experiments using GMM-based approximation', - url = 'https://www.gitlab.idiap.ch/bob/bob.bio.gmm', + url = 'https://gitlab.idiap.ch/bob/bob.bio.gmm', license = 'BSD', author = '<YourName>', author_email = '<YourEmail>', @@ -80,7 +80,7 @@ setup( # # Our database packages are good examples of namespace implementations # 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