Merge pull request #17445 from takanori-pskq/i13114-fix-refs-macro

DOC: Fix the references for macros

6 files changed, 37 insertions, 14 deletions

diff --git a/doc/source/reference/arrays.interface.rst b/doc/source/reference/arrays.interface.rst
index 73e4aef0c..49772a298 100644
--- a/doc/source/reference/arrays.interface.rst
+++ b/doc/source/reference/arrays.interface.rst
@@ -231,13 +231,15 @@ as::
 
 The flags member may consist of 5 bits showing how the data should be
 interpreted and one bit showing how the Interface should be
-interpreted.  The data-bits are :const:`CONTIGUOUS` (0x1),
-:const:`FORTRAN` (0x2), :const:`ALIGNED` (0x100), :const:`NOTSWAPPED`
-(0x200), and :const:`WRITEABLE` (0x400).  A final flag
-:const:`ARR_HAS_DESCR` (0x800) indicates whether or not this structure
+interpreted.  The data-bits are :c:macro:`NPY_ARRAY_C_CONTIGUOUS` (0x1),
+:c:macro:`NPY_ARRAY_F_CONTIGUOUS` (0x2), :c:macro:`NPY_ARRAY_ALIGNED` (0x100),
+:c:macro:`NPY_ARRAY_NOTSWAPPED` (0x200), and :c:macro:`NPY_ARRAY_WRITEABLE` (0x400).  A final flag
+:c:macro:`NPY_ARR_HAS_DESCR` (0x800) indicates whether or not this structure
 has the arrdescr field.  The field should not be accessed unless this
 flag is present.
 
+   .. c:macro:: NPY_ARR_HAS_DESCR
+
 .. admonition:: New since June 16, 2006:
 
    In the past most implementations used the ``desc`` member of the ``PyCObject``
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst
index cfe4d2d51..9fe45d2de 100644
--- a/doc/source/reference/c-api/array.rst
+++ b/doc/source/reference/c-api/array.rst
@@ -3259,6 +3259,8 @@ Memory management
     :c:data:`NPY_USE_PYMEM` is 0, if :c:data:`NPY_USE_PYMEM` is 1, then
     the Python memory allocator is used.
 
+    .. c:macro:: NPY_USE_PYMEM
+
 .. c:function:: int PyArray_ResolveWritebackIfCopy(PyArrayObject* obj)
 
     If ``obj.flags`` has :c:data:`NPY_ARRAY_WRITEBACKIFCOPY` or (deprecated)
@@ -3289,9 +3291,13 @@ be accomplished using two groups of macros. Typically, if one macro in
 a group is used in a code block, all of them must be used in the same
 code block. Currently, :c:data:`NPY_ALLOW_THREADS` is defined to the
 python-defined :c:data:`WITH_THREADS` constant unless the environment
-variable :c:data:`NPY_NOSMP` is set in which case
+variable ``NPY_NOSMP`` is set in which case
 :c:data:`NPY_ALLOW_THREADS` is defined to be 0.
 
+.. c:macro:: NPY_ALLOW_THREADS 
+
+.. c:macro:: WITH_THREADS
+
 Group 1
 """""""
 
diff --git a/doc/source/reference/c-api/config.rst b/doc/source/reference/c-api/config.rst
index c3e2c98af..cec5b973a 100644
--- a/doc/source/reference/c-api/config.rst
+++ b/doc/source/reference/c-api/config.rst
@@ -52,12 +52,15 @@ information is available to the pre-processor.
 
 .. c:macro:: NPY_SIZEOF_LONG_DOUBLE
 
-    sizeof(longdouble) (A macro defines **NPY_SIZEOF_LONGDOUBLE** as well.)
+.. c:macro:: NPY_SIZEOF_LONGDOUBLE
+
+    sizeof(longdouble)
 
 .. c:macro:: NPY_SIZEOF_PY_INTPTR_T
 
-    Size of a pointer on this platform (sizeof(void \*)) (A macro defines
-    NPY_SIZEOF_INTP as well.)
+.. c:macro:: NPY_SIZEOF_INTP
+
+    Size of a pointer on this platform (sizeof(void \*))
 
 
 Platform information
@@ -102,6 +105,12 @@ Platform information
     One of :c:data:`NPY_CPU_BIG`, :c:data:`NPY_CPU_LITTLE`,
     or :c:data:`NPY_CPU_UNKNOWN_ENDIAN`.
 
+    .. c:macro:: NPY_CPU_BIG
+
+    .. c:macro:: NPY_CPU_LITTLE
+
+    .. c:macro:: NPY_CPU_UNKNOWN_ENDIAN
+
 
 Compiler directives
 -------------------
diff --git a/doc/source/reference/c-api/dtype.rst b/doc/source/reference/c-api/dtype.rst
index a04d85212..47b998302 100644
--- a/doc/source/reference/c-api/dtype.rst
+++ b/doc/source/reference/c-api/dtype.rst
@@ -414,6 +414,12 @@ Printf Formatting
 For help in printing, the following strings are defined as the correct
 format specifier in printf and related commands.
 
-    :c:data:`NPY_LONGLONG_FMT`, :c:data:`NPY_ULONGLONG_FMT`,
-    :c:data:`NPY_INTP_FMT`, :c:data:`NPY_UINTP_FMT`,
-    :c:data:`NPY_LONGDOUBLE_FMT`
+.. c:macro:: NPY_LONGLONG_FMT
+
+.. c:macro:: NPY_ULONGLONG_FMT
+
+.. c:macro:: NPY_INTP_FMT
+
+.. c:macro:: NPY_UINTP_FMT
+
+.. c:macro:: NPY_LONGDOUBLE_FMT
diff --git a/doc/source/reference/c-api/iterator.rst b/doc/source/reference/c-api/iterator.rst
index 7eac8c367..ae96bb3fb 100644
--- a/doc/source/reference/c-api/iterator.rst
+++ b/doc/source/reference/c-api/iterator.rst
@@ -1264,7 +1264,7 @@ functions provide that information.
     NPY_MAX_INTP is placed in the stride.
 
     Once the iterator is prepared for iteration (after a reset if
-    :c:data:`NPY_DELAY_BUFALLOC` was used), call this to get the strides
+    :c:data:`NPY_ITER_DELAY_BUFALLOC` was used), call this to get the strides
     which may be used to select a fast inner loop function.  For example,
     if the stride is 0, that means the inner loop can always load its
     value into a variable once, then use the variable throughout the loop,
diff --git a/doc/source/reference/c-api/types-and-structures.rst b/doc/source/reference/c-api/types-and-structures.rst
index ee57d4680..cc961df3a 100644
--- a/doc/source/reference/c-api/types-and-structures.rst
+++ b/doc/source/reference/c-api/types-and-structures.rst
@@ -315,7 +315,7 @@ PyArrayDescr_Type and PyArray_Descr
 
         Bits set for the object data-type: ( :c:data:`NPY_LIST_PICKLE`
         \| :c:data:`NPY_USE_GETITEM` \| :c:data:`NPY_ITEM_IS_POINTER` \|
-        :c:data:`NPY_REFCOUNT` \| :c:data:`NPY_NEEDS_INIT` \|
+        :c:data:`NPY_ITEM_REFCOUNT` \| :c:data:`NPY_NEEDS_INIT` \|
         :c:data:`NPY_NEEDS_PYAPI`).
 
     .. c:function:: PyDataType_FLAGCHK(PyArray_Descr *dtype, int flags)
@@ -1395,7 +1395,7 @@ PyArrayInterface
        as the *descr* key in :obj:`__array_interface__`). This can be
        ``NULL`` if *typekind* and *itemsize* provide enough
        information. This field is also ignored unless
-       :c:data:`ARR_HAS_DESCR` flag is on in *flags*.
+       :c:data:`NPY_ARR_HAS_DESCR` flag is on in *flags*.
 
 
 Internally used structures