suppressing warnigns in Array docs, adding deprecation warnings at th…

…e module level documentation for array and dispatch

qiskit_dynamics/array/__init__.py

@@ -19,6 +19,16 @@
 
 .. currentmodule:: qiskit_dynamics.array
 
+
+.. warning::
+
+    The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
+    0.5.0. The use of the ``Array`` class is no longer required to work with different array
+    libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on
+    using different array libraries with Qiskit Dynamics. Users can now work directly with the
+    supported array type of their choice, without the need to wrap them to enable dispatching. The
+    ``array`` and ``dispatch`` submodules will be removed in version 0.6.0.
+
 This module contains an :class:`Array` class that wraps N-dimensional array objects from different
 libraries. It enables working with different array libraries through a common NumPy-based interface,
 along with other functionality for writing array-library agnostic code.
@@ -41,6 +51,12 @@
 Basic Usage
 -----------
 
+.. jupyter-execute::
+    :hide-code:
+    # suppress deprecation warnings
+    import warnings
+    warnings.filterwarnings('ignore', category=DeprecationWarning)
+
 When using the default ``numpy`` backend :class:`Array`, objects can be used interchangably with
 ``numpy.ndarray``. When ``numpy`` functions are applied to an :class:`Array` object the return type
 will be an :class:`Array` instead of an ``numpy.ndarray``.

qiskit_dynamics/arraylias/__init__.py

@@ -19,6 +19,15 @@
 
 .. currentmodule:: qiskit_dynamics.arraylias
 
+.. warning::
+
+    The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
+    0.5.0. The use of the ``Array`` class is no longer required to work with different array
+    libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on
+    using different array libraries with Qiskit Dynamics. Users can now work directly with the
+    supported array type of their choice, without the need to wrap them to enable dispatching. The
+    ``array`` and ``dispatch`` submodules will be removed in version 0.6.0.
+
 This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases
 provided by `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_. These are used to manage
 dispatching of array operations for the different array types supported by Qiskit Dynamics. They