summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-03-17 10:19:26 +0000
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-03-17 10:19:26 +0000
commiteea1ea59042f01a59af890c682a30d8158f54ca4 (patch)
tree17171881daed63fea2280df1de177f5f044bb8ae /docs/userguide
parent203c2f89d7fd315017c0834f74f5eb7f0f501cc5 (diff)
downloadpython-setuptools-git-eea1ea59042f01a59af890c682a30d8158f54ca4.tar.gz
Clarify deprecated fields for tool.setuptools
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/pyproject_config.rst23
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst
index 29db36cb..597bc33c 100644
--- a/docs/userguide/pyproject_config.rst
+++ b/docs/userguide/pyproject_config.rst
@@ -73,14 +73,15 @@ of the metadata used during the packaging process, there are still some
``setuptools``-specific configurations that can be set by users that require
customization.
These configurations are completely optional (and probably can be skipped when
-creating simple packages). They are equivalent to the :doc:`/references/keywords`
-used by the ``setup.py`` file:
+creating simple packages) and can be set via the ``tool.setuptools`` table.
+They are equivalent to the :doc:`/references/keywords` used by the ``setup.py`` file:
========================= =========================== =========================
Key Value Type (TOML) Notes
========================= =========================== =========================
``platforms`` array
-``zip-safe`` boolean
+``zip-safe`` boolean If not specified, ``setuptools`` will try to guess
+ a reasonable default for the package
``eager-resources`` array
``py-modules`` array See tip bellow
``packages`` array or ``find`` directive See tip bellow
@@ -98,8 +99,14 @@ Key Value Type (TOML) Notes
``obsoletes`` array **Ignored by pip**
========================= =========================== =========================
-The `TOML value types`_ ``array`` and ``table/inline-table`` are roughly
-equivalent to the Python's :obj:`dict` and :obj:`list` data types.
+In the table above, the `TOML value types`_ ``array`` and
+``table/inline-table`` are roughly equivalent to the Python's :obj:`dict` and
+:obj:`list` data types.
+
+Please note that some of these configurations are deprecated or at least
+discouraged, but they are made available to ensure portability.
+New packages should avoid relying on them, and existing packages should
+consider alternatives.
.. tip::
When both ``py-modules`` and ``packages`` are left unspecified,
@@ -162,9 +169,9 @@ corresponding entry is required in the ``tool.setuptools.dynamic`` table
version = {attr = "my_package.VERSION"}
readme = {file = ["README.rst", "USAGE.rst"]}
-In this example the ``attr`` attribute will read an attribute from the given
-module [#attr]_, while ``file`` will read all the given files and concatenate
-them in a single string.
+In the ``dynamic`` table, the ``attr`` directive will read an attribute from
+the given module [#attr]_, while ``file`` will read all the given files and
+concatenate them in a single string.
================= =================== =========================
Key Directive Notes