8000 Merge pull request #19567 from melissawm/docs-blas-warning · numpy/numpy@7b6c892 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7b6c892

Browse files
authored
Merge pull request #19567 from melissawm/docs-blas-warning
DOC: Fix Unknown section warning when building docs
2 parents 6e5cdc9 + 9236ddb commit 7b6c892

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

numpy/distutils/misc_util.py

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2376,47 +2376,47 @@ def show():
23762376
23772377
Notes
23782378
-----
2379-
Classes specifying the information to be printed are defined
2380-
in the `numpy.distutils.system_info` module.
2381-
2382-
Information may include:
2383-
2384-
* ``language``: language used to write the libraries (mostly
2385-
C or f77)
2386-
* ``libraries``: names of libraries found in the system
2387-
* ``library_dirs``: directories containing the libraries
2388-
* ``include_dirs``: directories containing library header files
2389-
* ``src_dirs``: directories containing library source files
2390-
* ``define_macros``: preprocessor macros used by
2391-
``distutils.setup``
2392-
* ``baseline``: minimum CPU features required
2393-
* ``found``: dispatched features supported in the system
2394-
* ``not found``: dispatched features that are not supported
2395-
in the system
2396-
2397-
NumPy BLAS/LAPACK Installation Notes
2398-
------------------------------------
2399-
Installing a numpy wheel (``pip install numpy`` or force it
2400-
via ``pip install numpy --only-binary :numpy: numpy``) includes
2401-
an OpenBLAS implementation of the BLAS and LAPACK linear algebra
2402-
APIs. In this case, ``library_dirs`` reports the original build
2403-
time configuration as compiled with gcc/gfortran; at run time
2404-
the OpenBLAS library is in
2405-
``site-packages/numpy.libs/`` (linux), or
2406-
``site-packages/numpy/.dylibs/`` (macOS), or
2407-
``site-packages/numpy/.libs/`` (windows).
2408-
2409-
Installing numpy from source
2410-
(``pip install numpy --no-binary numpy``) searches for BLAS and
2411-
LAPACK dynamic link libraries at build time as influenced by
2412-
environment variables NPY_BLAS_LIBS, NPY_CBLAS_LIBS, and
2413-
NPY_LAPACK_LIBS; or NPY_BLAS_ORDER and NPY_LAPACK_ORDER;
2414-
or the optional file ``~/.numpy-site.cfg``.
2415-
NumPy remembers those locations and expects to load the same
2416-
libraries at run-time.
2417-
In NumPy 1.21+ on macOS, 'accelerate' (Apple's Accelerate BLAS
2418-
library) is in the default build-time search order after
2419-
'openblas'.
2379+
1. Classes specifying the information to be printed are defined
2380+
in the `numpy.distutils.system_info` module.
2381+
2382+
Information may include:
2383+
2384+
* ``language``: language used to write the libraries (mostly
2385+
C or f77)
2386+
* ``libraries``: names of libraries found in the system
2387+
* ``library_dirs``: directories containing the libraries
2388+
* ``include_dirs``: directories containing library header files
2389+
* ``src_dirs``: directories containing library source files
2390+
* ``define_macros``: preprocessor macros used by
2391+
``distutils.setup``
2392+
* ``baseline``: minimum CPU features required
2393+
* ``found``: dispatched features supported in the system
2394+
* ``not found``: dispatched features that are not supported
2395+
in the system
2396+
2397+
2. NumPy BLAS/LAPACK Installation Notes
2398+
2399+
Installing a numpy wheel (``pip install numpy`` or force it
2400+
via ``pip install numpy --only-binary :numpy: numpy``) includes
2401+
an OpenBLAS implementation of the BLAS and LAPACK linear algebra
2402+
APIs. In this case, ``library_dirs`` reports the original build
2403+
time configuration as compiled with gcc/gfortran; at run time
2404+
the OpenBLAS library is in
2405+
``site-packages/numpy.libs/`` (linux), or
2406+
``site-packages/numpy/.dylibs/`` (macOS), or
2407+
``site-packages/numpy/.libs/`` (windows).
2408+
2409+
Installing numpy from source
2410+
(``pip install numpy --no-binary numpy``) searches for BLAS and
2411+
LAPACK dynamic link libraries at build time as influenced by
2412+
environment variables NPY_BLAS_LIBS, NPY_CBLAS_LIBS, and
2413+
NPY_LAPACK_LIBS; or NPY_BLAS_ORDER and NPY_LAPACK_ORDER;
2414+
or the optional file ``~/.numpy-site.cfg``.
2415+
NumPy remembers those locations and expects to load the same
2416+
libraries at run-time.
2417+
In NumPy 1.21+ on macOS, 'accelerate' (Apple's Accelerate BLAS
2418+
library) is in the default build-time search order after
2419+
'openblas'.
24202420
24212421
Examples
24222422
--------

0 commit comments

Comments
 (0)
0