Skip to content
Snippets Groups Projects
Commit 7887d072 authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !9
parents b7f00d2f 614a3934
No related branches found
No related tags found
1 merge request!9[Automatic] update links and the ci mostly
Pipeline #
...@@ -31,9 +31,29 @@ extensions = [ ...@@ -31,9 +31,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
...@@ -217,8 +237,16 @@ autodoc_default_flags = [ ...@@ -217,8 +237,16 @@ autodoc_default_flags = [
] ]
# For inter-documentation mapping: # For inter-documentation mapping:
from bob.extension.utils import link_documentation from bob.extension.utils import link_documentation, load_requirements
intersphinx_mapping = link_documentation() 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 # We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions # that are not in the list of accepted functions
......
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
.. _argparse: http://code.google.com/p/argparse/ .. _argparse: http://code.google.com/p/argparse/
.. _blitz++: http://www.oonumerics.org/blitz .. _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's website: https://www.idiap.ch/software/bob
.. _bob: https://www.idiap.ch/software/bob .. _bob: https://www.idiap.ch/software/bob
.. _boost: http://www.boost.org .. _boost: http://www.boost.org
...@@ -51,13 +51,13 @@ ...@@ -51,13 +51,13 @@
.. _python: http://www.python.org .. _python: http://www.python.org
.. _pypi: http://pypi.python.org .. _pypi: http://pypi.python.org
.. _qt4: http://qt.nokia.com/ .. _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 .. _scipy: http://www.scipy.org
.. _setuptools: http://trac.edgewall.org/wiki/setuptools .. _setuptools: http://trac.edgewall.org/wiki/setuptools
.. _sphinx: http://sphinx.pocoo.org .. _sphinx: http://sphinx.pocoo.org
.. _sqlalchemy: http://www.sqlalchemy.org/ .. _sqlalchemy: http://www.sqlalchemy.org/
.. _sqlite: http://www.sqlite.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 vision: http://torch3vision.idiap.ch
.. _torch 3: http://www.torch.ch .. _torch 3: http://www.torch.ch
.. _torch 5: http://torch5.sourceforge.net .. _torch 5: http://torch5.sourceforge.net
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment