Fixed WARNINGS in the documentation

parent 6c934a84
Pipeline #4130 passed with stages
in 66 minutes and 34 seconds
......@@ -329,9 +329,9 @@ bob::extension::FunctionDoc s_zigzag = bob::extension::FunctionDoc(
"\n"
"This method only supports arrays of the following data types:\n"
"\n"
" * :py:class:`numpy.uint8`\n"
" * :py:class:`numpy.uint16`\n"
" * :py:class:`numpy.float64` (or the native python ``float``)\n"
" * `numpy.uint8`\n"
" * `numpy.uint16`\n"
" * `numpy.float64` (or the native python ``float``)\n"
" \n"
" To create an object with a scalar type that will be accepted by this "
" method, use a construction like the following:\n"
......
......@@ -396,7 +396,7 @@ static auto extract = bob::extension::FunctionDoc(
"The destination array, if given, should be a 2D or 3D array of type float64 and allocated with the correct dimensions (see :py:func:`output_shape`). "
"If the destination array is not given (first version), it is generated in the required size. "
"The blocks can be split into either a 2D array of shape ``(block_index, coefficients)`` by setting ``flat=True``, or into a 3D array of shape ``(block_index_y, block_index_x, coefficients)`` with ``flat=False``.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, [flat]", "output")
......
......@@ -337,7 +337,7 @@ static auto extract = bob::extension::FunctionDoc(
".. note::\n\n Instead of the eyes, any two fixed positions can be used to normalize the face. "
"This can simply be achieved by selecting two other nodes in the constructor (see :py:class:`FaceEyesNorm`) and in this function. "
"Just make sure that 'right' and 'left' refer to the same landmarks in both functions.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, right_eye, left_eye", "output")
......
......@@ -242,7 +242,7 @@ static auto filter = bob::extension::FunctionDoc(
"filter",
"Smooths an image (2D/grayscale or 3D/color)",
"If given, the dst array should have the expected type (numpy.float64) and the same size as the src array.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -795,7 +795,7 @@ static auto process = bob::extension::FunctionDoc(
"process",
"Computes a Gaussian Pyramid for an input 2D image",
"If given, the results are put in the output ``dst``, which output should already be allocated and of the correct size (using the :py:func:`allocate_output` method).\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -237,7 +237,7 @@ static auto process = bob::extension::FunctionDoc(
"process",
"This function geometrically normalizes an image or a position in the image",
"The function rotates and scales the given image, or a position in image coordinates, such that the result is **visually** rotated and scaled with the :py:attr:`rotation_angle` and :py:attr:`scaling_factor`.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, output, center")
......
......@@ -176,7 +176,7 @@ static auto GLCM_doc = bob::extension::ClassDoc(
.add_prototype("[levels], [min_level], [max_level], [dtype]","")
.add_prototype("quantization_table","")
.add_prototype("glcm", "")
.add_parameter("dtype", ":py:attr:`numpy.dtype`", "[default: ``numpy.uint8``] The data-type for the GLCM class")
.add_parameter("dtype", ":py:class:`numpy.dtype`", "[default: ``numpy.uint8``] The data-type for the GLCM class")
.add_parameter("glcm", ":py:class:`bob.ip.base.GLCM`", "The GLCM object to use for copy-construction")
);
......@@ -622,7 +622,7 @@ static auto extract = bob::extension::FunctionDoc(
"extract",
"Extracts the GLCM matrix from the given input image",
"If given, the output array should have the expected type (numpy.float64) and the size as defined by :py:func:`output_shape` .\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, [output]", "output")
......
......@@ -577,7 +577,7 @@ static auto disableBlockNorm = bob::extension::FunctionDoc(
"disable_block_normalization",
"Disable block normalization",
"This is performed by setting parameters such that the cells are not further processed, i.e.:\n\n"
"* :py:attr:`block_ size` ``= (1, 1)``\n"
"* :py:attr:`block_size` ``= (1, 1)``\n"
"* :py:attr:`block_overlap` ``= (0, 0)``\n"
"* :py:attr:`block_norm` ``=`` :py:attr:`bob.ip.base.BlockNorm.Nonorm`",
true
......@@ -654,7 +654,7 @@ static auto extract = bob::extension::FunctionDoc(
"Extract the HOG descriptors",
"This extracts HOG descriptors from the input image. "
"The output is 3D, the first two dimensions being the y- and x- indices of the block, and the last one the index of the bin (among the concatenated cell histograms for this block).\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, [output]", "output")
......
......@@ -820,7 +820,7 @@ static auto extract = bob::extension::FunctionDoc(
"When MB-LBP features will be extracted, an integral image will be computed to speed up the calculation. "
"The integral image calculation can be done **before** this function is called, and the integral image can be passed to this function directly. "
"In this case, please set the ``is_integral_image`` parameter to ``True``.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, [is_integral_image]", "output")
......
......@@ -254,7 +254,7 @@ static auto process = bob::extension::FunctionDoc(
"Applies the Self Quotient Image algorithm to an image (2D/grayscale or color 3D/color) of type uint8, uint16 or double",
".. todo:: Check if this documentation is correct (seems to be copied from :py:class:`bob.ip.base.SelfQuotientImage`\n\n"
"If given, the ``dst`` array should have the type float and the same size as the ``src`` array.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -255,7 +255,7 @@ static auto process = bob::extension::FunctionDoc(
"process",
"Applies the Self Quotient Image algorithm to an image (2D/grayscale or 3D/color) of type uint8, uint16 or double",
"If given, the ``dst`` array should have the type float and the same size as the ``src`` array.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -617,7 +617,7 @@ static auto computeDescriptor = bob::extension::FunctionDoc(
"compute_descriptor",
"Computes SIFT descriptor for a 2D/grayscale image, at the given keypoints",
"If given, the results are put in the output ``dst``, which output should be of type float and allocated in the shape :py:func:`output_shape` method).\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, keypoints, [dst]", "dst")
......
......@@ -322,7 +322,7 @@ static auto process = bob::extension::FunctionDoc(
"The input array is a 2D array/grayscale image. "
"The destination array, if given, should be a 2D array of type float64 and allocated in the same size as the input. "
"If the destination array is not given, it is generated in the required size.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("input, [output]", "output")
......
......@@ -332,7 +332,7 @@ static auto extract = bob::extension::FunctionDoc(
"It returns a list of descriptors, one for each keypoint and orientation. "
"The first four values are the x, y, sigma and orientation of the values. "
"The 128 remaining values define the descriptor.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [keypoints]", "dst")
......@@ -666,7 +666,7 @@ static auto extract_ = bob::extension::FunctionDoc(
"Computes the dense SIFT features from an input image, using the VLFeat library",
"If given, the results are put in the output ``dst``, which should be of type float and allocated in the shape :py:func:`output_shape` method.\n\n"
".. todo:: Describe the output of the :py:func:`VLDSIFT.extract` method in more detail.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -205,7 +205,7 @@ static auto filter = bob::extension::FunctionDoc(
"filter",
"Smooths an image (2D/grayscale or 3D/color)",
"If given, the dst array should have the expected type (numpy.float64) and the same size as the src array.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
......@@ -297,7 +297,7 @@ static auto filter = bob::extension::FunctionDoc(
"filter",
"Filters the input image",
"If given, the dst array should have the expected type (numpy.float64) and the same size as the src array.\n\n"
".. note::\n\n The :py:func:`__call__` function is an alias for this method.",
".. note::\n\n The `__call__` function is an alias for this method.",
true
)
.add_prototype("src, [dst]", "dst")
......
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