Commit 16522dbc authored by André Anjos's avatar André Anjos 💬

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !2
parents 5d702965 b4f326cf
Pipeline #4805 passed with stages
in 23 minutes and 20 seconds
......@@ -20,10 +20,10 @@ 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.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
[scripts]
recipe = bob.buildout:scripts
......@@ -55,21 +55,22 @@ the import function:
Activation Functors
-------------------
.. cpp:type:: PyBobLearnActivationObject
.. c:type:: PyBobLearnActivationObject
The pythonic object representation for a ``bob::machine::Activation``
object. It is the base class of all activation functors available in
|project|. In C/C++ code, we recommend you only manipulate objects like this
to keep your code agnostic to the activation type being used.
The pythonic object representation for a
``bob::learn::activation::Activation`` object. It is the base class of all
activation functors available in |project|. In C/C++ code, we recommend you
only manipulate objects like this to keep your code agnostic to the
activation type being used.
.. code-block:: cpp
typedef struct {
PyObject_HEAD
bob::machine::Activation* base;
bob::learn::activation::Activation* base;
} PyBobLearnActivationObject;
.. cpp:member:: bob::machine::Activation* base
.. cpp:member:: bob::learn::activation::Activation* base
A pointer to the activation functor virtual implementation.
......@@ -80,13 +81,14 @@ Activation Functors
Returns ``1`` if it is, and ``0`` otherwise.
.. cpp:function:: PyObject* PyBobLearnActivation_NewFromActivation(boost::shared_ptr<bob::machine::Activation> a)
.. cpp:function:: PyObject* PyBobLearnActivation_NewFromActivation(boost::shared_ptr<bob::learn::activation::Activation> a)
Constructs a new :c:type:`PyBobLearnActivationObject` starting from a shared
pointer to a pre-allocated `bob::machine::Activation` instance. This API is
available so that return values from actuall C++ machines can be mapped into
Python. It is the sole way to build an object of type :py:class:`Activation`
without recurring to the derived classes.
pointer to a pre-allocated `bob::learn::activation::Activation` instance.
This API is available so that return values from actuall C++ machines can be
mapped into Python. It is the sole way to build an object of type
:py:class:`bob.learn.activation.Activation` without recurring to the derived
classes.
.. note::
......@@ -100,7 +102,7 @@ Activation Functors
typedef struct {
PyBobLearnActivationObject parent;
bob::machine::<Subtype>Activation* base;
bob::learn::activation::<Subtype>Activation* base;
} PyBobLearn<Subtype>ActivationObject;
Presently, ``<Subtype>`` can be one of:
......
......@@ -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
......@@ -216,8 +236,13 @@ 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=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
......
# No documentation exists for these c++ types
cpp:type bob
cpp:type bob::learn
cpp:type bob::learn::activation
cpp:type bob::learn::activation::Activation
cpp:type boost
cpp:type boost::shared_ptr
# These are not c++ types, but c - why Sphinx confuses those?
cpp:type PyObject
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