diff --git a/doc/conf.py b/doc/conf.py index 2915444674a7c164ac6ec984563d604f26be493e..0c06a74514027dd470f94a4ac683fec4e3dab715 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -31,9 +31,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 @@ -217,8 +237,16 @@ 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=['python','numpy'] + \ + 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 diff --git a/doc/links.rst b/doc/links.rst index cc43362a09c18c3824fd8c87df2faa7d79ecff8b..9c5747203c29f87f747be13ac737ac8f2d81f0af 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -10,7 +10,7 @@ .. _argparse: http://code.google.com/p/argparse/ .. _blitz++: http://www.oonumerics.org/blitz -.. _bob's idiap guide: http://github.com/idiap/bob/wiki/Using-Bob-at-Idiap +.. _bob's idiap guide: https://gitlab.idiap.ch/bob/bob/wikis/Using-Bob-at-Idiap .. _bob's website: https://www.idiap.ch/software/bob .. _bob: https://www.idiap.ch/software/bob .. _boost: http://www.boost.org @@ -51,13 +51,13 @@ .. _python: http://www.python.org .. _pypi: http://pypi.python.org .. _qt4: http://qt.nokia.com/ -.. _satellite packages: https://github.com/idiap/bob/wiki/Satellite-Packages +.. _satellite packages: https://gitlab.idiap.ch/bob/bob/wikis/Packages .. _scipy: http://www.scipy.org .. _setuptools: http://trac.edgewall.org/wiki/setuptools .. _sphinx: http://sphinx.pocoo.org .. _sqlalchemy: http://www.sqlalchemy.org/ .. _sqlite: http://www.sqlite.org/ -.. _submit a new bug report: https://github.com/idiap/bob/issues +.. _submit a new bug report: https://groups.google.com/forum/?fromgroups#!forum/bob-devel .. _torch 3 vision: http://torch3vision.idiap.ch .. _torch 3: http://www.torch.ch .. _torch 5: http://torch5.sourceforge.net