Commit 2e405ed4 authored by Amir Mohammadi's avatar Amir Mohammadi
Browse files

[doc] fix sphinx warnings

parent 5bc05035
Pipeline #6003 passed with stages
in 7 minutes and 46 seconds
......@@ -60,7 +60,7 @@ Machine
.. cpp:function:: int PyBobLearnMLPMachine_Check(PyObject* o)
Checks if the input object ``o`` is a
:cpp:class:`PyBobLearnMLPMachineObject`. Returns ``1`` if it is, and ``0``
:cpp:type:`PyBobLearnMLPMachineObject`. Returns ``1`` if it is, and ``0``
otherwise.
......@@ -93,7 +93,7 @@ Cost
.. cpp:function:: int PyBobLearnCost_Check(PyObject* o)
Checks if the input object ``o`` is a :cpp:class:`PyBobLearnCostObject`.
Checks if the input object ``o`` is a :cpp:type:`PyBobLearnCostObject`.
Returns ``1`` if it is, and ``0`` otherwise.
......@@ -137,7 +137,7 @@ Data Shuffler
.. cpp:function:: int PyBobLearnDataShuffler_Check(PyObject* o)
Checks if the input object ``o`` is a
:cpp:class:`PyBobLearnDataShufflerObject`. Returns ``1`` if it is, and
:cpp:type:`PyBobLearnDataShufflerObject`. Returns ``1`` if it is, and
``0`` otherwise.
......@@ -166,7 +166,7 @@ Trainers
.. cpp:function:: int PyBobLearnMLPTrainer_Check(PyObject* o)
Checks if the input object ``o`` is a
:cpp:class:`PyBobLearnMLPTrainerObject`. Returns ``1`` if it is, and ``0``
:cpp:type:`PyBobLearnMLPTrainerObject`. Returns ``1`` if it is, and ``0``
otherwise.
......@@ -197,7 +197,7 @@ Trainers
.. cpp:function:: int PyBobLearnBackProp_Check(PyObject* o)
Checks if the input object ``o`` is a
:cpp:class:`PyBobLearnBackPropObject`. Returns ``1`` if it is, and
:cpp:type:`PyBobLearnBackPropObject`. Returns ``1`` if it is, and
``0`` otherwise.
......@@ -227,7 +227,7 @@ Trainers
.. cpp:function:: int PyBobLearnRProp_Check(PyObject* o)
Checks if the input object ``o`` is a :cpp:class:`PyBobLearnRPropObject`.
Checks if the input object ``o`` is a :cpp:type:`PyBobLearnRPropObject`.
Returns ``1`` if it is, and ``0`` otherwise.
......
......@@ -10,9 +10,21 @@ cpp:type bob::learn::mlp::BackProp
cpp:type bob::learn::mlp::RProp
cpp:type boost
cpp:type boost::shared_ptr
cpp:typeOrConcept bob
cpp:typeOrConcept bob::learn
cpp:typeOrConcept bob::learn::mlp
cpp:typeOrConcept bob::learn::mlp::Machine
cpp:typeOrConcept bob::learn::mlp::Cost
cpp:typeOrConcept bob::learn::mlp::DataShuffler
cpp:typeOrConcept bob::learn::mlp::Trainer
cpp:typeOrConcept bob::learn::mlp::BackProp
cpp:typeOrConcept bob::learn::mlp::RProp
cpp:typeOrConcept boost
cpp:typeOrConcept boost::shared_ptr
# This is a C type that Sphinx confuses as a C++ type
cpp:type PyObject
cpp:typeOrConcept 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
......
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