diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-04-20 14:20:16 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-04-20 14:20:16 +0100 |
| commit | 000efbfae1e79d0a9fa9b16b55c4f5a2e90a64dd (patch) | |
| tree | b70e873af333c58b2695c2ddf554ead1520cb4a9 /docs | |
| parent | 2476f2fc1023117e2e2d1a6cc0c264b1539cfb05 (diff) | |
| parent | 1ba53bb500958f6549a2d3af0753c48599adadf5 (diff) | |
| download | python-setuptools-git-000efbfae1e79d0a9fa9b16b55c4f5a2e90a64dd.tar.gz | |
docs: Add a note about historical wheel use in requires (#3859)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/quickstart.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index bf92f6a2..3f97e8ef 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -56,6 +56,17 @@ containing a ``build-system`` section similar to the example below: This section declares what are your build system dependencies, and which library will be used to actually do the packaging. +.. note:: + + Historically this documentation has unnecessarily listed ``wheel`` + in the ``requires`` list, and many projects still do that. This is + not recommended. The backend automatically adds ``wheel`` dependency + when it is required, and listing it explicitly causes it to be + unnecessarily required for source distribution builds. + You should only include ``wheel`` in ``requires`` if you need to explicitly + access it during build time (e.g. if your project needs a ``setup.py`` + script that imports ``wheel``). + In addition to specifying a build system, you also will need to add some package information such as metadata, contents, dependencies, etc. This can be done in the same ``pyproject.toml`` [#beta]_ file, |
