diff --git a/develop.cfg b/develop.cfg index eafd52aa0802b46b8bf36ea4ccdfd382e75f8a0a..fa176f3f8c634d157c470bb6a97db0d9e3ccdcac 100644 --- a/develop.cfg +++ b/develop.cfg @@ -21,11 +21,11 @@ verbose = true newest = false [sources] -bob.extension = git git@gitlab.idiap.ch:bob/bob.extension -bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz -bob.core = git git@gitlab.idiap.ch:bob/bob.core -bob.math = git git@gitlab.idiap.ch:bob/bob.math -bob.io.base = git git@gitlab.idiap.ch:bob/bob.io.base +bob.extension = git https://gitlab.idiap.ch/bob/bob.extension +bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz +bob.core = git https://gitlab.idiap.ch/bob/bob.core +bob.math = git https://gitlab.idiap.ch/bob/bob.math +bob.io.base = git https://gitlab.idiap.ch/bob/bob.io.base [scripts] recipe = bob.buildout:scripts diff --git a/doc/conf.py b/doc/conf.py index 592d54edf05d02ec4da3a771764f3ffe157d238d..358f024195b547c1b1bc4c49fcb714b131dbe38b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -25,7 +25,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', - 'matplotlib.sphinxext.plot_directive', + 'matplotlib.sphinxext.plot_directive' ] import sphinx @@ -35,6 +35,25 @@ if sphinx.__version__ >= "1.4.1": 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 @@ -197,6 +216,7 @@ html_favicon = 'img/favicon.ico' # Output file base name for HTML help builder. htmlhelp_basename = project_variable + u'_doc' + # -- Post configuration -------------------------------------------------------- # Included after all input documents @@ -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