Commit b45c29ea authored by André Anjos's avatar André Anjos 💬
Browse files

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !2
parents 7255f23f 8371889d
Pipeline #4822 passed with stages
in 21 minutes and 9 seconds
......@@ -868,7 +868,7 @@ PyDoc_STRVAR(s_load_str, "load");
PyDoc_STRVAR(s_load_doc,
"o.load(f) -> None\n\
\n\
Loads itself from a :py:class:`bob.io.HDF5File`\n\
Loads itself from a :py:class:`bob.io.base.HDF5File`\n\
\n\
");
......@@ -902,7 +902,7 @@ PyDoc_STRVAR(s_save_str, "save");
PyDoc_STRVAR(s_save_doc,
"o.save(f) -> None\n\
\n\
Saves itself at a :py:class:`bob.io.HDF5File`\n\
Saves itself at a :py:class:`bob.io.base.HDF5File`\n\
\n\
");
......
......@@ -22,12 +22,12 @@ 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.io.base = git git@gitlab.idiap.ch:bob/bob.io.base
bob.math = git git@gitlab.idiap.ch:bob/bob.math
bob.learn.activation = git git@gitlab.idiap.ch:bob/bob.learn.activation
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.io.base = git https://gitlab.idiap.ch/bob/bob.io.base
bob.math = git https://gitlab.idiap.ch/bob/bob.math
bob.learn.activation = git https://gitlab.idiap.ch/bob/bob.learn.activation
[scripts]
recipe = bob.buildout:scripts
......@@ -25,14 +25,35 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
#'matplotlib.sphinxext.plot_directive'
]
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
......@@ -216,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
......
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Tue 13 May 09:30:06 2014 CEST
..
.. Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
.. testsetup:: *
......@@ -27,7 +24,7 @@ described below. We start this tutorial by examplifying how to actually use an
MLP.
To instantiate a new (uninitialized) :py:class:`bob.learn.mlp.Machine` pass a
shape descriptor as a :py:func:`tuple`. The shape parameter should contain the
shape descriptor as a :py:class:`tuple`. The shape parameter should contain the
input size as the first parameter and the output size as the last parameter.
The parameters in between define the number of neurons in the hidden layers of
the MLP. For example ``(3, 3, 1)`` defines an MLP with 3 inputs, 1 single
......
# These are not documented anywhere
cpp:type bob
cpp:type bob::learn
cpp:type bob::learn::mlp
cpp:type bob::learn::mlp::Machine
cpp:type bob::learn::mlp::Cost
cpp:type bob::learn::mlp::DataShuffler
cpp:type bob::learn::mlp::Trainer
cpp:type bob::learn::mlp::BackProp
cpp:type bob::learn::mlp::RProp
cpp:type boost
cpp:type boost::shared_ptr
# This is a C type that Sphinx confuses as a C++ type
cpp:type PyObject
# This is a function in Python 2.7 and a class in Python 3.x
# Ignore Python 2.7 error - 3.x is the future
py:class tuple
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment