DOC: replace autsummary for numpy.dtypes with enumerated list

[skip azp] [skip actions] [skip cirrus]
numpy · Jan 25, 2024 · c0c1851 · c0c1851
1 parent e999062
commit c0c1851
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 39 deletions.
diff --git a/doc/source/reference/routines.dtypes.rst b/doc/source/reference/routines.dtypes.rst
@@ -3,9 +3,69 @@
 Data type classes
 =================
 
-.. currentmodule:: numpy
+.. automodule:: numpy.dtypes
+   :no-members:
 
-.. autosummary::
-   :toctree: generated/
+Boolean
+-------
 
-   dtypes
+.. attribute:: BoolDType
+
+Bit-sized integers
+------------------
+
+.. attribute:: Int8DType
+               UInt8DType
+               Int16DType
+               UInt16DType
+               Int32DType
+               UInt32DType
+               Int64DType
+               UInt64DType
+
+C-named integers (may be aliases)
+---------------------------------
+
+.. attribute:: ByteDType
+               UByteDType
+               ShortDType
+               UShortDType
+               IntDType
+               UIntDType
+               LongDType
+               ULongDType
+               LongLongDType
+               ULongLongDType
+
+Floating point
+--------------
+
+.. attribute:: Float16DType
+               Float32DType
+               Float64DType
+               LongDoubleDType
+
+Complex
+-------
+
+.. attribute:: Complex64DType
+               Complex128DType
+               CLongDoubleDType
+
+Strings and Bytestrings
+-----------------------
+
+.. attribute:: StrDType
+               BytesDType
+
+Times
+-----
+
+.. attribute:: DateTime64DType
+               TimeDelta64DType
+
+Others
+------
+
+.. attribute:: ObjectDType
+               VoidDType
diff --git a/numpy/dtypes.py b/numpy/dtypes.py
@@ -20,41 +20,6 @@
 also be instantiated or used directly.  Direct use of these classes is not
 typical, since their scalar counterparts (e.g. ``np.float64``) or strings
 like ``"float64"`` can be used.
-
-.. list-table::
-    :header-rows: 1
-
-    * - Group
-      - DType class
-
-    * - Boolean
-      - ``BoolDType``
-
-    * - Bit-sized integers
-      - ``Int8DType``, ``UInt8DType``, ``Int16DType``, ``UInt16DType``,
-        ``Int32DType``, ``UInt32DType``, ``Int64DType``, ``UInt64DType``
-
-    * - C-named integers (may be aliases)
-      - ``ByteDType``, ``UByteDType``, ``ShortDType``, ``UShortDType``,
-        ``IntDType``, ``UIntDType``, ``LongDType``, ``ULongDType``,
-        ``LongLongDType``, ``ULongLongDType``
-
-    * - Floating point
-      - ``Float16DType``, ``Float32DType``, ``Float64DType``,
-        ``LongDoubleDType``
-
-    * - Complex
-      - ``Complex64DType``, ``Complex128DType``, ``CLongDoubleDType``
-
-    * - Strings and Bytestrings
-      - ``StrDType``, ``BytesDType``
-
-    * - Times
-      - ``DateTime64DType``, ``TimeDelta64DType``
-
-    * - Others
-      - ``ObjectDType``, ``VoidDType``
-
 """
 
 __all__ = []