Use array_api as opposed to signatures for 2021.12 autodoc

honno · honno · commit af88a6150812 · 2022-11-15T11:21:26.000Z
diff --git a/spec/2021.12/API_specification/array_object.rst b/spec/2021.12/API_specification/array_object.rst
@@ -246,7 +246,7 @@ Bitwise Operators
 
 -------------------------------------------------
 
-.. currentmodule:: signatures.array_object
+.. currentmodule:: array_api
 
 Attributes
 ----------
diff --git a/spec/2021.12/API_specification/constants.rst b/spec/2021.12/API_specification/constants.rst
@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.constants
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/creation_functions.rst b/spec/2021.12/API_specification/creation_functions.rst
@@ -11,7 +11,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.creation_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/data_type_functions.rst b/spec/2021.12/API_specification/data_type_functions.rst
@@ -9,7 +9,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.data_type_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/data_types.rst b/spec/2021.12/API_specification/data_types.rst
@@ -100,7 +100,7 @@ Methods
 ..
   NOTE: please keep the functions in alphabetical order
 
-.. currentmodule:: signatures.data_types
+.. currentmodule:: array_api.data_types
 
 .. autosummary::
    :toctree: generated
diff --git a/spec/2021.12/API_specification/elementwise_functions.rst b/spec/2021.12/API_specification/elementwise_functions.rst
@@ -19,7 +19,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.elementwise_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/indexing.rst b/spec/2021.12/API_specification/indexing.rst
@@ -154,7 +154,7 @@ Multi-dimensional arrays must extend the concept of single-axis indexing to mult
 - Each ``None`` in the selection tuple must expand the dimensions of the resulting selection by one dimension of size ``1``. The position of the added dimension must be the same as the position of ``None`` in the selection tuple.
 
   .. note::
-    Expanding dimensions can be equivalently achieved via repeated invocation of :func:`~signatures.manipulation_functions.expand_dims`.
+    Expanding dimensions can be equivalently achieved via repeated invocation of :func:`~array_api.expand_dims`.
 
 - Except in the case of providing a single ellipsis (e.g., ``A[2:10, ...]`` or ``A[1:, ..., 2:5]``), the number of provided single-axis indexing expressions (excluding ``None``) should equal ``N``. For example, if ``A`` has rank ``2``, a single-axis indexing expression should be explicitly provided for both axes (e.g., ``A[2:10, :]``). An ``IndexError`` exception should be raised if the number of provided single-axis indexing expressions (excluding ``None``) is less than ``N``.
 
@@ -181,7 +181,7 @@ Boolean Array Indexing
 An array must support indexing where the **sole index** is an ``M``-dimensional boolean array ``B`` with shape ``S1 = (s1, ..., sM)`` according to the following rules. Let ``A`` be an ``N``-dimensional array with shape ``S2 = (s1, ..., sM, ..., sN)``.
 
   .. note::
-     The prohibition against combining boolean array indices with other single-axis indexing expressions includes the use of ``None``. To expand dimensions of the returned array, use repeated invocation of :func:`~signatures.manipulation_functions.expand_dims`.
+     The prohibition against combining boolean array indices with other single-axis indexing expressions includes the use of ``None``. To expand dimensions of the returned array, use repeated invocation of :func:`~array_api.expand_dims`.
 
 - If ``N >= M``, then ``A[B]`` must replace the first ``M`` dimensions of ``A`` with a single dimension having a size equal to the number of ``True`` elements in ``B``. The values in the resulting array must be in row-major (C-style order); this is equivalent to ``A[nonzero(B)]``.
 
diff --git a/spec/2021.12/API_specification/linear_algebra_functions.rst b/spec/2021.12/API_specification/linear_algebra_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 * Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
 * Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
 
-.. currentmodule:: signatures.linear_algebra_functions
+.. currentmodule:: array_api
 
 Objects in API
 --------------
diff --git a/spec/2021.12/API_specification/manipulation_functions.rst b/spec/2021.12/API_specification/manipulation_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.manipulation_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/searching_functions.rst b/spec/2021.12/API_specification/searching_functions.rst
@@ -16,7 +16,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.searching_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/set_functions.rst b/spec/2021.12/API_specification/set_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.set_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/sorting_functions.rst b/spec/2021.12/API_specification/sorting_functions.rst
@@ -19,7 +19,7 @@ A conforming implementation of the array API standard must provide and support t
 
   While defining a sort order for IEEE 754 floating-point numbers is recommended in order to facilitate reproducible and consistent sort results, doing so is not currently required by this specification.
 
-.. currentmodule:: signatures.sorting_functions
+.. currentmodule:: array_api
 
 Objects in API
 --------------
diff --git a/spec/2021.12/API_specification/statistical_functions.rst b/spec/2021.12/API_specification/statistical_functions.rst
@@ -15,7 +15,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.statistical_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/utility_functions.rst b/spec/2021.12/API_specification/utility_functions.rst
@@ -15,7 +15,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.utility_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/conf.py b/spec/2021.12/conf.py
@@ -4,4 +4,4 @@
 from _array_api_conf import *
 
 release = "2021.12"
-sys.modules["signatures"] = stubs_mod
+sys.modules["array_api"] = stubs_mod
diff --git a/spec/2021.12/extensions/linear_algebra_functions.rst b/spec/2021.12/extensions/linear_algebra_functions.rst
@@ -74,7 +74,7 @@ Accordingly, the standardization process affords the opportunity to reduce inter
 
     where ``dot`` is overloaded based on input array dimensionality and ``vdot`` and ``inner`` exhibit a high degree of overlap with other interfaces. By consolidating interfaces and more clearly delineating behavior, this specification aims to ensure that each interface has a unique purpose and defined use case.
 
-.. currentmodule:: signatures.linalg
+.. currentmodule:: array_api.linalg
 
 Objects in API
 --------------
diff --git a/src/array_api_stubs/_2021_12/__init__.py b/src/array_api_stubs/_2021_12/__init__.py
@@ -0,0 +1,14 @@
+from .array_object import *
+from .constants import *
+from .creation_functions import *
+from .data_type_functions import *
+from . import data_types as dtype
+from .elementwise_functions import *
+from .linear_algebra_functions import *
+from .manipulation_functions import *
+from .searching_functions import *
+from .set_functions import *
+from .sorting_functions import *
+from .statistical_functions import *
+from .utility_functions import *
+from . import linalg
diff --git a/src/array_api_stubs/_2021_12/array_object.py b/src/array_api_stubs/_2021_12/array_object.py
@@ -135,7 +135,7 @@ def __abs__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.abs`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.abs`.
         """
 
     def __add__(self: array, other: Union[int, float, array], /) -> array:
@@ -181,7 +181,7 @@ def __add__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.add`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.add`.
         """
 
     def __and__(self: array, other: Union[int, bool, array], /) -> array:
@@ -202,7 +202,7 @@ def __and__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_and`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_and`.
         """
 
     def __array_namespace__(self: array, /, *, api_version: Optional[str] = None) -> Any:
@@ -239,7 +239,7 @@ def __bool__(self: array, /) -> bool:
 
     def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> PyCapsule:
         """
-        Exports the array for consumption by :func:`~signatures.creation_functions.from_dlpack` as a DLPack capsule.
+        Exports the array for consumption by :func:`array_api.from_dlpack` as a DLPack capsule.
 
         Parameters
         ----------
@@ -294,7 +294,7 @@ def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> P
 
     def __dlpack_device__(self: array, /) -> Tuple[Enum, int]:
         """
-        Returns device type and device ID in DLPack format. Meant for use within :func:`~signatures.creation_functions.from_dlpack`.
+        Returns device type and device ID in DLPack format. Meant for use within :func:`array_api.from_dlpack`.
 
         Parameters
         ----------
@@ -336,7 +336,7 @@ def __eq__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.equal`.
         """
 
     def __float__(self: array, /) -> float:
@@ -411,7 +411,7 @@ def __floordiv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.floor_divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.floor_divide`.
         """
 
     def __ge__(self: array, other: Union[int, float, array], /) -> array:
@@ -432,7 +432,7 @@ def __ge__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.greater_equal`.
         """
 
     def __getitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], /) -> array:
@@ -470,7 +470,7 @@ def __gt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.greater`.
         """
 
     def __index__(self: array, /) -> int:
@@ -522,7 +522,7 @@ def __invert__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_invert`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_invert`.
         """
 
     def __le__(self: array, other: Union[int, float, array], /) -> array:
@@ -543,7 +543,7 @@ def __le__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.less_equal`.
         """
 
     def __lshift__(self: array, other: Union[int, array], /) -> array:
@@ -564,7 +564,7 @@ def __lshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_left_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_left_shift`.
         """
 
     def __lt__(self: array, other: Union[int, float, array], /) -> array:
@@ -585,7 +585,7 @@ def __lt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.less`.
         """
 
     def __matmul__(self: array, other: array, /) -> array:
@@ -616,7 +616,7 @@ def __matmul__(self: array, other: array, /) -> array:
 
 
         .. note::
-           Results must equal the results returned by the equivalent function :func:`~signatures.linear_algebra_functions.matmul`.
+           Results must equal the results returned by the equivalent function :func:`array_api.matmul`.
 
         **Raises**
 
@@ -676,7 +676,7 @@ def __mod__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.remainder`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.remainder`.
         """
 
     def __mul__(self: array, other: Union[int, float, array], /) -> array:
@@ -715,7 +715,7 @@ def __mul__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.multiply`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.multiply`.
         """
 
     def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
@@ -736,7 +736,7 @@ def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.not_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.not_equal`.
         """
 
     def __neg__(self: array, /) -> array:
@@ -758,7 +758,7 @@ def __neg__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.negative`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.negative`.
         """
 
     def __or__(self: array, other: Union[int, bool, array], /) -> array:
@@ -779,7 +779,7 @@ def __or__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_or`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_or`.
         """
 
     def __pos__(self: array, /) -> array:
@@ -798,7 +798,7 @@ def __pos__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.positive`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.positive`.
         """
 
     def __pow__(self: array, other: Union[int, float, array], /) -> array:
@@ -853,7 +853,7 @@ def __pow__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.pow`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.pow`.
         """
 
     def __rshift__(self: array, other: Union[int, array], /) -> array:
@@ -874,7 +874,7 @@ def __rshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_right_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_right_shift`.
         """
 
     def __setitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], value: Union[int, float, bool, array], /) -> None:
@@ -918,7 +918,7 @@ def __sub__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.subtract`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.subtract`.
         """
 
     def __truediv__(self: array, other: Union[int, float, array], /) -> array:
@@ -971,7 +971,7 @@ def __truediv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.divide`.
         """
 
     def __xor__(self: array, other: Union[int, bool, array], /) -> array:
@@ -992,7 +992,7 @@ def __xor__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_xor`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`array_api.bitwise_xor`.
         """
 
     def to_device(self: array, device: Device, /, *, stream: Optional[Union[int, Any]] = None) -> array:
diff --git a/src/array_api_stubs/_2021_12/creation_functions.py b/src/array_api_stubs/_2021_12/creation_functions.py
@@ -54,7 +54,7 @@ def asarray(obj: Union[array, bool, int, float, NestedSequence, SupportsBufferPr
         .. admonition:: Note
            :class: note
 
-           If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`signatures.data_type_functions.astype`.
+           If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`array_api.astype`.
 
         .. note::
            If an input value exceeds the precision of the resolved output array data type, behavior is left unspecified and, thus, implementation-defined.
diff --git a/src/array_api_stubs/_2021_12/linalg.py b/src/array_api_stubs/_2021_12/linalg.py
