Fixed warnings, minor updates

michaeleg21 · syurkevi · commit 63ccf69ec0bd · 2025-09-04T18:23:12.000-04:00
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -22,3 +22,4 @@ codecov>=2.1.12
 # Allows documentation
 sphinx>=7.3.7
 sphinxawesome_theme>=5.2.0
+sphinx_collapse>=0.1.3
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,9 +12,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'ArrayFire'
-copyright = '2024, Michael Egwuatu'
-author = 'Michael Egwuatu'
-release = '6/11/2024'
+copyright = '2024, ArrayFire'
+author = 'ArrayFire'
+release = ''
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -39,4 +39,8 @@
 html_static_path = ['_static']
 html_permalinks = False
 
+# -- Suppress specific warnings --------------------------------------------
 
+suppress_warnings = [
+    'ref.include_missing',
+]
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -2,34 +2,6 @@ Examples
 ========
 
 
-
-Introduction
-------------
-
-This is the introductory section of File 1.
-
-Modules
--------
-
-Here is some content for the first section.
-
-Mod
-~~~
-
-This is a subsection under Section 1.
-
-Mod1
-~~~~
-
-More content for the second section.
-
-Mod2
-~~~~
-
-This concludes the content of File 1.
-
-Mod3
-~~~~
-
-Mod4
-~~~~
+TO DO
+-----
+ADD LIST OF EXAMPLES
diff --git a/docs/functions/device.rst b/docs/functions/device.rst
@@ -14,6 +14,7 @@ The 'af.device()' function is useful for managing and querying the device that A
 - Getting the Current Device: Retrieve the index of the currently selected device.
 - Setting the Current Device: Select a specific device for computations.
 - Querying Device Properties: Obtain information about the current device.
+
 This functionality is important for applications that need to explicitly choose between multiple GPUs or check device capabilities.
 
 Function Documentation
diff --git a/docs/functions/fft.rst b/docs/functions/fft.rst
@@ -14,12 +14,14 @@ The 'af.fft()' function performs a discrete Fourier transform of the input array
 - Signal Processing: Analyzing the frequency components of a signal.
 - Image Processing: Transforming images to the frequency domain for various processing tasks.
 - Numerical Analysis: Solving differential equations and other problems where Fourier methods are applicable.
+
 The function supports:
 
 - 1D FFT: Transforming 1D arrays (vectors).
 - 2D FFT: Transforming 2D arrays (matrices).
 - 3D FFT: Transforming 3D arrays (volumes).
 - Multi-dimensional FFTs: Transforming arrays of higher dimensions.
+
 The FFT can be computed along specified dimensions or all dimensions of the input array.
 
 Function Documentation
diff --git a/docs/functions/index.rst b/docs/functions/index.rst
@@ -0,0 +1,39 @@
+.. toctree:: 
+    :maxdepth: 2
+    :caption: Functions:
+
+    transpose
+    array
+    ones
+    zeros
+    sum
+    subtract
+    sttdev
+    randu
+    randn
+    det
+    device
+    divide
+    dot
+    eig
+    fft
+    get
+    get_device
+    inv
+    join
+    matmul
+    max
+    mean
+    median
+    min
+    multiply
+    prod
+    reorder
+    set_device
+    slice
+    sqrt
+    add
+    exp
+    log
+    ifft
+    reshape
diff --git a/docs/functions/join.rst b/docs/functions/join.rst
@@ -18,10 +18,10 @@ Function Documentation
 .. sidebar:: af.join()
 
     Syntax:
-        af.join(dim, *arrays)
+        af.join(dim, \*arrays)
     
     Parameters:
         'dim': The dimension along which the arrays will be concatenated. This is an integer indicating the axis along which the join operation will take place.
-        '*arrays': The arrays to be concatenated. These can be 1D, 2D, or higher-dimensional arrays, and they must be compatible in all dimensions except the specified dimension.
+        '\*arrays': The arrays to be concatenated. These can be 1D, 2D, or higher-dimensional arrays, and they must be compatible in all dimensions except the specified dimension.
     Returns:
         An ArrayFire array that is the result of concatenating the input arrays along the specified dimension.
diff --git a/docs/functions/reorder.rst b/docs/functions/reorder.rst
@@ -16,11 +16,11 @@ Function Documentation
 .. sidebar:: af.reorder()
 
     Syntax:
-        af.reorder(array, *order)
+        af.reorder(array, \*order)
     
     Parameters:
         'array': The ArrayFire array whose dimensions are to be reordered.
-        '*order': The new order of dimensions specified as a sequence of integers. Each integer represents the index of the dimension in the new order.
+        '\*order': The new order of dimensions specified as a sequence of integers. Each integer represents the index of the dimension in the new order.
 
     Returns:
         An ArrayFire array with the dimensions reordered according to the specified order.
diff --git a/docs/functions/reshape.rst b/docs/functions/reshape.rst
@@ -16,10 +16,10 @@ Function Documentation
 .. sidebar:: af.reshape()
 
     Syntax:
-        af.reshape(array,*new_shape)    
+        af.reshape(array,\*new_shape)
         
     Parameters:
         'array': The ArrayFire array to be reshaped.
-        '*new_shape': The new shape for the array, specified as a sequence of integers. The product of these dimensions must equal the total number of elements in the original array.
+        '\*new_shape': The new shape for the array, specified as a sequence of integers. The product of these dimensions must equal the total number of elements in the original array.
     Returns:
         An ArrayFire array with the specified new shape.
diff --git a/docs/functions/slice.rst b/docs/functions/slice.rst
@@ -16,12 +16,12 @@ Function Documentation
 .. sidebar:: af.slice()
 
     Syntax:
-        af.slice(array, *start_indices, *end_indices)
+        af.slice(array, \*start_indices, \*end_indices)
     
     Parameters:
         'array': The ArrayFire array from which the subarray will be extracted.
-        '*start_indices': A sequence of integers specifying the starting indices for each dimension.
-        '*end_indices': A sequence of integers specifying the ending indices for each dimension.
+        '\*start_indices': A sequence of integers specifying the starting indices for each dimension.
+        '\*end_indices': A sequence of integers specifying the ending indices for each dimension.
 
     Returns:
         An ArrayFire array containing the extracted subarray.
diff --git a/docs/functions/transpose.rst b/docs/functions/transpose.rst
@@ -16,11 +16,11 @@ Function Documentation
 .. sidebar:: af.transpose()
 
     Syntax:
-        af.transpose(array, *permutation)
+        af.transpose(array, \*permutation)
     
     Parameters:
         'array': The ArrayFire array to be transposed.
-        '*permutation': An optional sequence of integers specifying the new order of dimensions. If not provided, the function defaults to transposing the last two dimensions.
+        '\*permutation': An optional sequence of integers specifying the new order of dimensions. If not provided, the function defaults to transposing the last two dimensions.
 
     Returns:
         An ArrayFire array that is the transpose of the input array, with dimensions permuted according to the provided permutation.
diff --git a/docs/functions/zeros.rst b/docs/functions/zeros.rst
@@ -6,6 +6,7 @@ Function
 --------
 :literal:`af.zeros()`
     - Python interface to create array filled with zeros.
+
 Detailed Description
 --------------------
 The 'af.zeros()' function creates an ArrayFire array where every element is initialized to zero. It is particularly useful when you need to allocate space for an array but want to ensure that all values start from zero. This is often used in numerical methods, data processing, and initialization of variables in scientific computing.
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
@@ -24,6 +24,7 @@ ArrayFire provides one generic container object, the array on which functions an
 * u64 64-bit unsigned integer (:literal:`uintl`)
 * s16 16-bit signed integer (:literal:`short`)
 * u16 16-bit unsigned integer (:literal:`unsigned short`)
+
 Most of these data types are supported on all modern GPUs; however, some older devices may lack support for double precision arrays. In this case, a runtime error will be generated when the array is constructed.
 
 If not specified otherwise, :literal:`array`s are created as single precision floating point numbers (:literal:`f32`).
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,18 +3,29 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to TestProject2's documentation!
-========================================
+Welcome to ArrayFire's documentation!
+=====================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
    :caption: Contents:
 
    overview
    tutorial
    functions
    releasenotes
    examples
+   arrayandmatrixmanipulation
+   arrayfirejitcodegeneration
+   configuringarrayfireenvironment
+   debuggingarrayfirecode
+   gettingstarted
+   indexing
+   installation
+   introductiontovectorization
+   linux
+   functions/index
+
 
 Indices and tables
 ==================
@@ -24,19 +35,6 @@ Indices and tables
 
 
 
-.. automodule:: pkg.sub_pkg1
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: pkg.sub_pkg2
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-   
-
 
 
 
diff --git a/docs/indexing.py b/docs/indexing.py
@@ -102,7 +102,7 @@
 # [indexing11-endsnippet]
 
 
-# [indexing11-snippet]
+# [indexing12-snippet]
 
 hidx = [4, 3, 4, 0]
 hvals = [9.0, 8.0, 7.0, 6.0]
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -13,6 +13,7 @@ Install Instructions
 * :ref:`macOs <macOS>`
 
 .. _Windows:
+
 Windows
 =======
 Once the ArrayFire has been downloaded, run the installer.
@@ -23,6 +24,7 @@ For more information on using ArrayFire on Windows, visit the following page.
 
 
 .. _Linux:
+
 Linux
 =====
 
@@ -44,6 +46,7 @@ Given sudo permissions, the ArrayFire libraries can be added to the path via :li
 
     echo /opt/arrayfire/lib64 > /etc/ld.so.conf.d/arrayfire.conf
     sudo ldconfig
+
 Otherwise, the :literal:`LD_LIBRARY_PATH` environment variable can be set so that the shared library loader can find the ArrayFire libraries.
 
 For more information on using ArrayFire on Linux, visit the following page*.
@@ -74,6 +77,7 @@ To install these dependencies on common Linux distributions:
 
 
 .. _macOS:
+
 macOS
 =====
 
diff --git a/docs/introductiontovectorization.rst b/docs/introductiontovectorization.rst
@@ -25,7 +25,7 @@ Most ArrayFire functions are vectorized. A small subset of these include:
 +---------------------------------------+--------------------------------------------+
 | Operator Category                     |         Functions                          |
 +=======================================+============================================+
-| Arithmetic Operations                 | +, -, *, /, %, >, <                        |
+| Arithmetic Operations                 | +, -, \*, /, %, >, <                        |
 +---------------------------------------+--------------------------------------------+
 | Logical Operations                    | &&, ||(or), <, >, ==, != etc.              |
 +---------------------------------------+--------------------------------------------+
diff --git a/docs/linux.rst b/docs/linux.rst
@@ -4,6 +4,7 @@ Using ArrayFire on Linux
 Once you have :ref:`installed <Linux>` ArrayFire on your system, the next thing to do is set up your build system. On Linux, you can create ArrayFire projects using almost any editor, compiler, or build system. The only requirements are that you include the ArrayFire header directories and link with the ArrayFire library you intend to use i.e. CUDA, OpenCL, oneAPI, CPU, or Unified backends.
 
 .. _bigpicture:
+
 The big picture
 ===============
 
@@ -87,13 +88,15 @@ Next we need to instruct CMake to create build instructions and then compile. We
     cd build
     cmake ..
     make
+
 NOTE: If you have installed ArrayFire to a non-standard location, CMake can still help you out. When you execute CMake specify the path to ArrayFire installation root as :literal:`ArrayFire_DIR` variable.
 
 For example, if ArrayFire were installed locally to :literal:`/home/user/ArrayFire` then you would modify the :literal:`cmake` command above to contain the following definition:
 
 .. code-block:: text
 
     cmake -DArrayFire_DIR=/home/user/ArrayFire ..
+
 You can also specify this information in the :literal:`ccmake` command-line interface.
 
 
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -3,33 +3,7 @@ Release Notes
 
 
 
-Introduction
-------------
+TO DO
+-----
+Add Release Notes
 
-This is the introductory section of File 1.
-
-Modules
--------
-
-Here is some content for the first section.
-
-Mod
-~~~
-
-This is a subsection under Section 1.
-
-Mod1
-~~~~
-
-More content for the second section.
-
-Mod2
-~~~~
-
-This concludes the content of File 1.
-
-Mod3
-~~~~
-
-Mod4
-~~~~
