Skip to content

Commit 8d45b9b

Browse files
authored
Merge pull request numpy#22154 from rgommers/warning-pin-setuptools
DOC: add more prominent warnings to pin setuptools
2 parents a36783e + ad4d292 commit 8d45b9b

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

doc/source/dev/depending_on_numpy.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,14 @@ specify the version with ``==`` to the lowest supported version. For your other
104104
build dependencies you can probably be looser, however it's still important to
105105
set lower and upper bounds for each dependency. It's fine to specify either a
106106
range or a specific version for a dependency like ``wheel`` or ``setuptools``.
107-
It's recommended to set the upper bound of the range to the latest already
108-
released version of ``wheel`` and ``setuptools`` - this prevents future
109-
releases from breaking your packages on PyPI.
107+
108+
.. warning::
109+
110+
Note that ``setuptools`` does major releases often and those may contain
111+
changes that break ``numpy.distutils``, which will *not* be updated anymore
112+
for new ``setuptools`` versions. It is therefore recommended to set an
113+
upper version bound in your build configuration for the last known version
114+
of ``setuptools`` that works with your build.
110115

111116

112117
Runtime dependency & version ranges

doc/source/reference/distutils.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ Packaging (:mod:`numpy.distutils`)
99
``numpy.distutils`` is deprecated, and will be removed for
1010
Python >= 3.12. For more details, see :ref:`distutils-status-migration`
1111

12+
.. warning::
13+
14+
Note that ``setuptools`` does major releases often and those may contain
15+
changes that break ``numpy.distutils``, which will *not* be updated anymore
16+
for new ``setuptools`` versions. It is therefore recommended to set an
17+
upper version bound in your build configuration for the last known version
18+
of ``setuptools`` that works with your build.
19+
1220
NumPy provides enhanced distutils functionality to make it easier to
1321
build and install sub-packages, auto-generate code, and extension
1422
modules that use Fortran-compiled libraries. To use features of NumPy

0 commit comments

Comments
 (0)