Merge pull request #915 from xtensor-stack/fix/doc

Finish documentation cleanup
xtensor-stack · Apr 7, 2023 · 79964d7 · 79964d7
2 parents 030507c + 7c7adcc
commit 79964d7
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 240 deletions.
diff --git a/docs/source/api/basic_functions.rst b/docs/source/api/basic_functions.rst
diff --git a/docs/source/api/error_functions.rst b/docs/source/api/error_functions.rst
diff --git a/docs/source/api/exponential_functions.rst b/docs/source/api/exponential_functions.rst
diff --git a/docs/source/api/hyperbolic_functions.rst b/docs/source/api/hyperbolic_functions.rst
diff --git a/docs/source/api/math_index.rst b/docs/source/api/math_index.rst
@@ -30,9 +30,7 @@
 Mathematical functions
 ======================
 
-.. toctree::
-
-   basic_functions
+Basic functions:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`abs`                       | absolute value                                     |
@@ -56,9 +54,7 @@ Mathematical functions
 | :cpp:func:`clip`                      | clipping operation                                 |
 +---------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   exponential_functions
+Exponential functions:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`exp`                       | natural exponential function                       |
@@ -78,9 +74,7 @@ Mathematical functions
 | :cpp:func:`log1p`                     | natural logarithm of one plus function             |
 +---------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   power_functions
+Power functions:
 
 +-----------------------------------------+----------------------------------------------------+
 | :cpp:func:`pow`                         | power function                                     |
@@ -94,9 +88,7 @@ Mathematical functions
 | :cpp:func:`hypot`                       | hypotenuse function                                |
 +-----------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   trigonometric_functions
+Trigonometric functions:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`sin`                       | sine function                                      |
@@ -116,9 +108,7 @@ Mathematical functions
 | :cpp:func:`atan2`                     | arc tangent function, determining quadrants        |
 +---------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   hyperbolic_functions
+Hyperbolic functions:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`sinh`                      | hyperbolic sine function                           |
@@ -134,9 +124,7 @@ Mathematical functions
 | :cpp:func:`atanh`                     | inverse hyperbolic tangent function                |
 +---------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   error_functions
+Error functions:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`erf`                       | error function                                     |
@@ -148,9 +136,7 @@ Mathematical functions
 | :cpp:func:`lgamma`                    | natural logarithm of the gamma function            |
 +---------------------------------------+----------------------------------------------------+
 
-.. toctree::
-
-   nearint_operations
+Nearint operations:
 
 +---------------------------------------+----------------------------------------------------+
 | :cpp:func:`ceil`                      | nearest integers not less                          |
@@ -167,3 +153,20 @@ Mathematical functions
 +---------------------------------------+----------------------------------------------------+
 
 
+----
+
+.. doxygengroup:: batch_math
+   :project: xsimd
+   :content-only:
+
+.. doxygengroup:: batch_trigo
+   :project: xsimd
+   :content-only:
+
+.. doxygengroup:: batch_rounding
+   :project: xsimd
+   :content-only:
+
+.. doxygengroup:: batch_math_extra
+   :project: xsimd
+   :content-only:
diff --git a/docs/source/api/nearint_operations.rst b/docs/source/api/nearint_operations.rst
diff --git a/docs/source/api/power_functions.rst b/docs/source/api/power_functions.rst
diff --git a/docs/source/api/trigonometric_functions.rst b/docs/source/api/trigonometric_functions.rst