Skip to content

Fix errors and warnings in the documentation generation #2891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohanMabille merged 4 commits into from
Apr 15, 2026
Merged

Fix errors and warnings in the documentation generation #2891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c9e046
Fix documentation
Alex-PLACET Apr 14, 2026
9975597
Update documentation for index-related functions and operators, and c…
Alex-PLACET Apr 14, 2026
ff0605b
Fix formatting and improve documentation clarity in various files
Alex-PLACET Apr 14, 2026
49db96d
Fix formatting by removing spaces between function calls and parenthe…
Alex-PLACET Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/source/api/accumulating_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,5 @@ Accumulating functions

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

.. doxygenfunction:: cumsum(E&&)

.. doxygenfunction:: cumsum(E&&, std::ptrdiff_t)

.. doxygenfunction:: cumprod(E&&)

.. doxygenfunction:: cumprod(E&&, std::ptrdiff_t)
.. doxygengroup:: acc_functions
:members:
25 changes: 2 additions & 23 deletions docs/source/api/basic_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,5 @@ Basic functions

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

.. doxygenfunction:: abs(E&&)

.. doxygenfunction:: fabs(E&&)

.. doxygenfunction:: fmod(E1&&, E2&&)

.. doxygenfunction:: remainder(E1&&, E2&&)

.. doxygenfunction:: fma(E1&&, E2&&, E3&&)

.. doxygenfunction:: maximum(E1&&, E2&&)

.. doxygenfunction:: minimum(E1&&, E2&&)

.. doxygenfunction:: fmax(E1&&, E2&&)

.. doxygenfunction:: fmin(E1&&, E2&&)

.. doxygenfunction:: fdim(E1&&, E2&&)

.. doxygenfunction:: clip(E1&&, E2&&, E3&&)

.. doxygenfunction:: sign(E&&)
.. doxygengroup:: basic_functions
:members:
11 changes: 2 additions & 9 deletions docs/source/api/classif_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,5 @@ Classification functions

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

.. doxygenfunction:: isfinite(E&&)

.. doxygenfunction:: isinf(E&&)

.. doxygenfunction:: isnan(E&&)

.. doxygenfunction:: isclose(E1&&, E2&&, double, double, bool)

.. doxygenfunction:: allclose(E1&&, E2&, double, double)
.. doxygengroup:: classif_functions
:members:
9 changes: 2 additions & 7 deletions docs/source/api/error_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,5 @@ Error and gamma functions

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

.. doxygenfunction:: erf(E&&)

.. doxygenfunction:: erfc(E&&)

.. doxygenfunction:: tgamma(E&&)

.. doxygenfunction:: lgamma(E&&)
.. doxygengroup:: err_functions
:members:
15 changes: 2 additions & 13 deletions docs/source/api/exponential_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,5 @@ Exponential functions

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

.. doxygenfunction:: exp(E&&)

.. doxygenfunction:: exp2(E&&)

.. doxygenfunction:: expm1(E&&)

.. doxygenfunction:: log(E&&)

.. doxygenfunction:: log2(E&&)

.. doxygenfunction:: log10(E&&)

.. doxygenfunction:: log1p(E&&)
.. doxygengroup:: exp_functions
:members:
19 changes: 2 additions & 17 deletions docs/source/api/hyperbolic_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,5 @@ Hyperbolic functions

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

.. _sinh-function-reference:
.. doxygenfunction:: sinh(E&&)

.. _cosh-function-reference:
.. doxygenfunction:: cosh(E&&)

.. _tanh-function-reference:
.. doxygenfunction:: tanh(E&&)

.. _asinh-func-ref:
.. doxygenfunction:: asinh(E&&)

.. _acosh-func-ref:
.. doxygenfunction:: acosh(E&&)

.. _atanh-func-ref:
.. doxygenfunction:: atanh(E&&)
.. doxygengroup:: hyper_functions
:members:
9 changes: 3 additions & 6 deletions docs/source/api/index_related.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ Index related functions

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

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

.. doxygenfunction:: nonzero(const T&)

.. doxygenfunction:: argwhere

.. doxygenfunction:: from_indices
``xt::from_indices`` is documented on the ``xtensor`` API page.
25 changes: 2 additions & 23 deletions docs/source/api/nan_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,5 @@ NaN functions

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

.. doxygenfunction:: nan_to_num(E&&)

.. doxygenfunction:: nanmin(E&&, X&&, EVS)

.. doxygenfunction:: nanmax(E&&, X&&, EVS)

.. doxygenfunction:: nansum(E&&, X&&, EVS)

.. doxygenfunction:: nanmean(E&&, X&&, EVS)

.. doxygenfunction:: nanvar(E&&, X&&, EVS)

.. doxygenfunction:: nanstd(E&&, X&&, EVS)

.. doxygenfunction:: nanprod(E&&, X&&, EVS)

.. doxygenfunction:: nancumsum(E&&)

.. doxygenfunction:: nancumsum(E&&, std::ptrdiff_t)

.. doxygenfunction:: nancumprod(E&&)

.. doxygenfunction:: nancumprod(E&&, std::ptrdiff_t)
.. doxygengroup:: nan_functions
:members:
13 changes: 2 additions & 11 deletions docs/source/api/nearint_operations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,5 @@ Nearest integer floating point operations

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

.. doxygenfunction:: ceil(E&&)

.. doxygenfunction:: floor(E&&)

.. doxygenfunction:: trunc(E&&)

.. doxygenfunction:: round(E&&)

.. doxygenfunction:: nearbyint(E&&)

.. doxygenfunction:: rint(E&&)
.. doxygengroup:: nearint_functions
:members:
71 changes: 10 additions & 61 deletions docs/source/api/operators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,68 +9,17 @@ Operators and related functions

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

.. doxygenfunction:: operator+(E&&)
.. doxygengroup:: arithmetic_operators
:members:

.. doxygenfunction:: operator-(E&&)
.. doxygengroup:: logical_operators
:members:

.. doxygenfunction:: operator+(E1&&, E2&&)
.. doxygengroup:: comparison_operators
:members:

.. doxygenfunction:: operator-(E1&&, E2&&)
.. doxygengroup:: bitwise_operators
:members:

.. doxygenfunction:: operator*(E1&&, E2&&)

.. doxygenfunction:: operator/(E1&&, E2&&)

.. doxygenfunction:: operator||(E1&&, E2&&)

.. doxygenfunction:: operator&&(E1&&, E2&&)

.. doxygenfunction:: operator!(E&&)

.. doxygenfunction:: where(E1&&, E2&&, E3&&)

.. doxygenfunction:: any(E&&)

.. doxygenfunction:: all(E&&)

.. doxygenfunction:: operator<(E1&&, E2&&)

.. doxygenfunction:: operator<=(E1&&, E2&&)

.. doxygenfunction:: operator>(E1&&, E2&&)

.. doxygenfunction:: operator>=(E1&&, E2&&)

.. doxygenfunction:: operator==(const xexpression<E1>&, const xexpression<E2>&)

.. doxygenfunction:: operator!=(const xexpression<E1>&, const xexpression<E2>&)

.. doxygenfunction:: equal(E1&&, E2&&)

.. doxygenfunction:: not_equal(E1&&, E2&&)

.. doxygenfunction:: less(E1&& e1, E2&& e2)

.. doxygenfunction:: less_equal(E1&& e1, E2&& e2)

.. doxygenfunction:: greater(E1&& e1, E2&& e2)

.. doxygenfunction:: greater_equal(E1&& e1, E2&& e2)

.. doxygenfunction:: operator&(E1&&, E2&&)

.. doxygenfunction:: operator|(E1&&, E2&&)

.. doxygenfunction:: operator^(E1&&, E2&&)

.. doxygenfunction:: operator~(E&&)

.. doxygenfunction:: left_shift(E1&&, E2&&)

.. doxygenfunction:: right_shift(E1&&, E2&&)

.. doxygenfunction:: operator<<(E1&&, E2&&)

.. doxygenfunction:: operator>>(E1&&, E2&&)

.. doxygenfunction:: cast(E&&)
.. doxygengroup:: casting_operators
:members:
15 changes: 2 additions & 13 deletions docs/source/api/power_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,5 @@ Power functions

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

.. doxygenfunction:: pow(E1&&, E2&&)

.. doxygenfunction:: pow(E&&)

.. doxygenfunction:: square(E1&&)

.. doxygenfunction:: cube(E1&&)

.. doxygenfunction:: sqrt(E&&)

.. doxygenfunction:: cbrt(E&&)

.. doxygenfunction:: hypot(E1&&, E2&&)
.. doxygengroup:: pow_functions
:members:
61 changes: 3 additions & 58 deletions docs/source/api/reducing_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,62 +9,7 @@ Reducing functions

**xtensor** provides the following reducing functions for xexpressions:

Defined in ``xtensor/core/xmath.hpp``
Defined in ``xtensor/core/xmath.hpp`` and ``xtensor/reducers/xnorm.hpp``.

.. doxygenfunction:: sum(E&&, EVS)

.. doxygenfunction:: sum(E&&, X&&, EVS)

.. doxygenfunction:: prod(E&&, EVS)

.. doxygenfunction:: prod(E&&, X&&, EVS)

.. doxygenfunction:: mean(E&&, EVS)

.. doxygenfunction:: mean(E&&, X&&, EVS)

.. doxygenfunction:: average(E&&, EVS)

.. doxygenfunction:: variance(E&&, EVS)

.. doxygenfunction:: variance(E&&, X&&, EVS)

.. doxygenfunction:: variance(E&&, X&&, const D&, EVS)

.. doxygenfunction:: stddev(E&&, EVS)

.. doxygenfunction:: stddev(E&&, X&&, EVS)

.. doxygenfunction:: diff(const xexpression<T>&, unsigned int, std::ptrdiff_t)

.. doxygenfunction:: amax(E&&, EVS)

.. doxygenfunction:: amax(E&&, X&&, EVS)

.. doxygenfunction:: amin(E&&, EVS)

.. doxygenfunction:: amin(E&&, X&&, EVS)

.. doxygenfunction:: trapz(const xexpression<T>&, double, std::ptrdiff_t)

.. doxygenfunction:: trapz(const xexpression<T>&, const xexpression<E>&, std::ptrdiff_t)

Defined in ``xtensor/reducers/xnorm.hpp``

.. doxygenfunction:: norm_l0(E&&, X&&, EVS)

.. doxygenfunction:: norm_l1(E&&, X&&, EVS)

.. doxygenfunction:: norm_sq(E&&, X&&, EVS)

.. doxygenfunction:: norm_l2(E&&, X&&, EVS)

.. doxygenfunction:: norm_linf(E&&, X&&, EVS)

.. doxygenfunction:: norm_lp_to_p(E&&, double, X&&, EVS)

.. doxygenfunction:: norm_lp(E&&, double, X&&, EVS)

.. doxygenfunction:: norm_induced_l1(E&&, EVS)

.. doxygenfunction:: norm_induced_linf(E&&, EVS)
.. doxygengroup:: red_functions
:members:
15 changes: 2 additions & 13 deletions docs/source/api/trigonometric_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,5 @@ Trigonometric functions

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

.. doxygenfunction:: sin(E&&)

.. doxygenfunction:: cos(E&&)

.. doxygenfunction:: tan(E&&)

.. doxygenfunction:: asin(E&&)

.. doxygenfunction:: acos(E&&)

.. doxygenfunction:: atan(E&&)

.. doxygenfunction:: atan2(E1&&, E2&&)
.. doxygengroup:: trigo_functions
:members:
16 changes: 16 additions & 0 deletions docs/source/api/xaccessible.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. Copyright (c) 2016, Johan Mabille, Sylvain Corlay and Wolf Vollprecht

Distributed under the terms of the BSD 3-Clause License.

The full license is in the file LICENSE, distributed with this software.

xaccessible
===========

Defined in ``xtensor/core/xaccessible.hpp``

.. doxygenclass:: xt::xconst_accessible
:members:

.. doxygenclass:: xt::xaccessible
:members:
2 changes: 1 addition & 1 deletion docs/source/api/xbuilder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Defined in ``xtensor/generators/xbuilder.hpp``

.. doxygenfunction:: xt::empty(const S&)

.. doxygenfunction:: xt::full_like(const xexpression<E>&)
.. doxygenfunction:: xt::full_like(const xexpression<E>&, typename E::value_type)

.. doxygenfunction:: xt::empty_like(const xexpression<E>&)

Expand Down
16 changes: 16 additions & 0 deletions docs/source/api/xfft.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. Copyright (c) 2016, Johan Mabille, Sylvain Corlay and Wolf Vollprecht

Distributed under the terms of the BSD 3-Clause License.

The full license is in the file LICENSE, distributed with this software.

xfft
====

Defined in ``xtensor/misc/xfft.hpp``

.. doxygenfunction:: xt::fft::fft(E&&, std::ptrdiff_t)

.. doxygenfunction:: xt::fft::ifft(E&&, std::ptrdiff_t)

.. doxygenfunction:: xt::fft::convolve(E1&&, E2&&, std::ptrdiff_t)
Loading
Loading