Skip to content

Commit d670054

Browse files
Alex-PLACETAlex-PLACET
authored
Fix errors and warnings in the documentation generation (#2891)
# Checklist - [x] The title and commit message(s) are descriptive. - [x] Small commits made to fix your PR have been squashed to avoid history pollution. - [x] Tests have been added for new features or bug fixes. - [x] API of new functions and classes are documented. # Description The goal of this pullrequest is to fix thee error and warning during the documentation generation. --------- Co-authored-by: Alexis Placet <2400067+Alex-PLACET@users.noreply.github.com>
1 parent f21347a commit d670054

46 files changed

Lines changed: 160 additions & 349 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/source/api/accumulating_functions.rst‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,5 @@ Accumulating functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: cumsum(E&&)
15-
16-
.. doxygenfunction:: cumsum(E&&, std::ptrdiff_t)
17-
18-
.. doxygenfunction:: cumprod(E&&)
19-
20-
.. doxygenfunction:: cumprod(E&&, std::ptrdiff_t)
14+
.. doxygengroup:: acc_functions
15+
:members:

‎docs/source/api/basic_functions.rst‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,5 @@ Basic functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: abs(E&&)
15-
16-
.. doxygenfunction:: fabs(E&&)
17-
18-
.. doxygenfunction:: fmod(E1&&, E2&&)
19-
20-
.. doxygenfunction:: remainder(E1&&, E2&&)
21-
22-
.. doxygenfunction:: fma(E1&&, E2&&, E3&&)
23-
24-
.. doxygenfunction:: maximum(E1&&, E2&&)
25-
26-
.. doxygenfunction:: minimum(E1&&, E2&&)
27-
28-
.. doxygenfunction:: fmax(E1&&, E2&&)
29-
30-
.. doxygenfunction:: fmin(E1&&, E2&&)
31-
32-
.. doxygenfunction:: fdim(E1&&, E2&&)
33-
34-
.. doxygenfunction:: clip(E1&&, E2&&, E3&&)
35-
36-
.. doxygenfunction:: sign(E&&)
14+
.. doxygengroup:: basic_functions
15+
:members:

‎docs/source/api/classif_functions.rst‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,5 @@ Classification functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: isfinite(E&&)
15-
16-
.. doxygenfunction:: isinf(E&&)
17-
18-
.. doxygenfunction:: isnan(E&&)
19-
20-
.. doxygenfunction:: isclose(E1&&, E2&&, double, double, bool)
21-
22-
.. doxygenfunction:: allclose(E1&&, E2&, double, double)
14+
.. doxygengroup:: classif_functions
15+
:members:

‎docs/source/api/error_functions.rst‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,5 @@ Error and gamma functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: erf(E&&)
15-
16-
.. doxygenfunction:: erfc(E&&)
17-
18-
.. doxygenfunction:: tgamma(E&&)
19-
20-
.. doxygenfunction:: lgamma(E&&)
14+
.. doxygengroup:: err_functions
15+
:members:

‎docs/source/api/exponential_functions.rst‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,5 @@ Exponential functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: exp(E&&)
15-
16-
.. doxygenfunction:: exp2(E&&)
17-
18-
.. doxygenfunction:: expm1(E&&)
19-
20-
.. doxygenfunction:: log(E&&)
21-
22-
.. doxygenfunction:: log2(E&&)
23-
24-
.. doxygenfunction:: log10(E&&)
25-
26-
.. doxygenfunction:: log1p(E&&)
14+
.. doxygengroup:: exp_functions
15+
:members:

‎docs/source/api/hyperbolic_functions.rst‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,5 @@ Hyperbolic functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. _sinh-function-reference:
15-
.. doxygenfunction:: sinh(E&&)
16-
17-
.. _cosh-function-reference:
18-
.. doxygenfunction:: cosh(E&&)
19-
20-
.. _tanh-function-reference:
21-
.. doxygenfunction:: tanh(E&&)
22-
23-
.. _asinh-func-ref:
24-
.. doxygenfunction:: asinh(E&&)
25-
26-
.. _acosh-func-ref:
27-
.. doxygenfunction:: acosh(E&&)
28-
29-
.. _atanh-func-ref:
30-
.. doxygenfunction:: atanh(E&&)
14+
.. doxygengroup:: hyper_functions
15+
:members:

‎docs/source/api/index_related.rst‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ Index related functions
99

1010
Defined in ``xtensor/core/xoperation.hpp``
1111

12-
.. doxygenfunction:: where(const T&)
12+
The logical operator group documents the index-producing overloads of
13+
``xt::where``, ``xt::nonzero`` and ``xt::argwhere``.
1314

14-
.. doxygenfunction:: nonzero(const T&)
15-
16-
.. doxygenfunction:: argwhere
17-
18-
.. doxygenfunction:: from_indices
15+
``xt::from_indices`` is documented on the ``xtensor`` API page.

‎docs/source/api/nan_functions.rst‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,5 @@ NaN functions
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: nan_to_num(E&&)
15-
16-
.. doxygenfunction:: nanmin(E&&, X&&, EVS)
17-
18-
.. doxygenfunction:: nanmax(E&&, X&&, EVS)
19-
20-
.. doxygenfunction:: nansum(E&&, X&&, EVS)
21-
22-
.. doxygenfunction:: nanmean(E&&, X&&, EVS)
23-
24-
.. doxygenfunction:: nanvar(E&&, X&&, EVS)
25-
26-
.. doxygenfunction:: nanstd(E&&, X&&, EVS)
27-
28-
.. doxygenfunction:: nanprod(E&&, X&&, EVS)
29-
30-
.. doxygenfunction:: nancumsum(E&&)
31-
32-
.. doxygenfunction:: nancumsum(E&&, std::ptrdiff_t)
33-
34-
.. doxygenfunction:: nancumprod(E&&)
35-
36-
.. doxygenfunction:: nancumprod(E&&, std::ptrdiff_t)
14+
.. doxygengroup:: nan_functions
15+
:members:

‎docs/source/api/nearint_operations.rst‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,5 @@ Nearest integer floating point operations
1111

1212
Defined in ``xtensor/core/xmath.hpp``
1313

14-
.. doxygenfunction:: ceil(E&&)
15-
16-
.. doxygenfunction:: floor(E&&)
17-
18-
.. doxygenfunction:: trunc(E&&)
19-
20-
.. doxygenfunction:: round(E&&)
21-
22-
.. doxygenfunction:: nearbyint(E&&)
23-
24-
.. doxygenfunction:: rint(E&&)
14+
.. doxygengroup:: nearint_functions
15+
:members:

‎docs/source/api/operators.rst‎

Lines changed: 10 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -9,68 +9,17 @@ Operators and related functions
99

1010
Defined in ``xtensor/core/xmath.hpp`` and ``xtensor/core/xoperation.hpp``
1111

12-
.. doxygenfunction:: operator+(E&&)
12+
.. doxygengroup:: arithmetic_operators
13+
:members:
1314

14-
.. doxygenfunction:: operator-(E&&)
15+
.. doxygengroup:: logical_operators
16+
:members:
1517

16-
.. doxygenfunction:: operator+(E1&&, E2&&)
18+
.. doxygengroup:: comparison_operators
19+
:members:
1720

18-
.. doxygenfunction:: operator-(E1&&, E2&&)
21+
.. doxygengroup:: bitwise_operators
22+
:members:
1923

20-
.. doxygenfunction:: operator*(E1&&, E2&&)
21-
22-
.. doxygenfunction:: operator/(E1&&, E2&&)
23-
24-
.. doxygenfunction:: operator||(E1&&, E2&&)
25-
26-
.. doxygenfunction:: operator&&(E1&&, E2&&)
27-
28-
.. doxygenfunction:: operator!(E&&)
29-
30-
.. doxygenfunction:: where(E1&&, E2&&, E3&&)
31-
32-
.. doxygenfunction:: any(E&&)
33-
34-
.. doxygenfunction:: all(E&&)
35-
36-
.. doxygenfunction:: operator<(E1&&, E2&&)
37-
38-
.. doxygenfunction:: operator<=(E1&&, E2&&)
39-
40-
.. doxygenfunction:: operator>(E1&&, E2&&)
41-
42-
.. doxygenfunction:: operator>=(E1&&, E2&&)
43-
44-
.. doxygenfunction:: operator==(const xexpression<E1>&, const xexpression<E2>&)
45-
46-
.. doxygenfunction:: operator!=(const xexpression<E1>&, const xexpression<E2>&)
47-
48-
.. doxygenfunction:: equal(E1&&, E2&&)
49-
50-
.. doxygenfunction:: not_equal(E1&&, E2&&)
51-
52-
.. doxygenfunction:: less(E1&& e1, E2&& e2)
53-
54-
.. doxygenfunction:: less_equal(E1&& e1, E2&& e2)
55-
56-
.. doxygenfunction:: greater(E1&& e1, E2&& e2)
57-
58-
.. doxygenfunction:: greater_equal(E1&& e1, E2&& e2)
59-
60-
.. doxygenfunction:: operator&(E1&&, E2&&)
61-
62-
.. doxygenfunction:: operator|(E1&&, E2&&)
63-
64-
.. doxygenfunction:: operator^(E1&&, E2&&)
65-
66-
.. doxygenfunction:: operator~(E&&)
67-
68-
.. doxygenfunction:: left_shift(E1&&, E2&&)
69-
70-
.. doxygenfunction:: right_shift(E1&&, E2&&)
71-
72-
.. doxygenfunction:: operator<<(E1&&, E2&&)
73-
74-
.. doxygenfunction:: operator>>(E1&&, E2&&)
75-
76-
.. doxygenfunction:: cast(E&&)
24+
.. doxygengroup:: casting_operators
25+
:members:

0 commit comments

Comments
 (0)