From e1740329f00bd37010fa1c260a7a36d9dfd4b78b Mon Sep 17 00:00:00 2001
From: Alexandru Fikl <alexfikl@gmail.com>
Date: Wed, 2 Aug 2023 20:53:18 +0300
Subject: [PATCH] tools: add to docs

---
 doc/misc.rst   |  2 ++
 sumpy/tools.py | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+)

diff --git a/doc/misc.rst b/doc/misc.rst
index f977fffd..ac1ea388 100644
--- a/doc/misc.rst
+++ b/doc/misc.rst
@@ -1,6 +1,8 @@
 Misc Tools
 ==========
 
+.. automodule:: sumpy.tools
+
 .. automodule:: sumpy.derivative_taker
 
 .. automodule:: sumpy.symbolic
diff --git a/sumpy/tools.py b/sumpy/tools.py
index 32b4d3ee..daad3853 100644
--- a/sumpy/tools.py
+++ b/sumpy/tools.py
@@ -45,6 +45,65 @@ if TYPE_CHECKING:
 
     from sumpy.kernel import Kernel
 
+logger = logging.getLogger(__name__)
+
+
+__doc__ = """
+Tools
+=====
+
+.. autofunction:: to_complex_dtype
+.. autofunction:: is_obj_array_like
+.. autofunction:: vector_to_device
+.. autofunction:: vector_from_device
+.. autoclass:: OrderedSet
+
+Multi-index Helpers
+-------------------
+
+.. autofunction:: add_mi
+.. autofunction:: mi_factorial
+.. autofunction:: mi_increment_axis
+.. autofunction:: mi_set_axis
+.. autofunction:: mi_power
+
+Symbolic Helpers
+----------------
+
+.. autofunction:: add_to_sac
+.. autofunction:: gather_arguments
+.. autofunction:: gather_source_arguments
+.. autofunction:: gather_loopy_arguments
+.. autofunction:: gather_loopy_source_arguments
+
+.. autoclass:: ScalingAssignmentTag
+.. autoclass:: KernelComputation
+.. autoclass:: KernelCacheMixin
+
+.. autofunction:: reduced_row_echelon_form
+.. autofunction:: nullspace
+
+FFT
+---
+
+.. autofunction:: fft
+.. autofunction:: fft_toeplitz_upper_triangular
+.. autofunction:: matvec_toeplitz_upper_triangular
+
+.. autoclass:: FFTBackend
+.. autofunction:: loopy_fft
+.. autofunction:: get_opencl_fft_app
+.. autofunction:: run_opencl_fft
+
+Profiling
+---------
+
+.. autofunction:: get_native_event
+.. autoclass:: ProfileGetter
+.. autoclass:: AggregateProfilingEvent
+.. autoclass:: MarkerBasedProfilingEvent
+"""
+
 
 # {{{ multi_index helpers
 
-- 
GitLab