summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoralvy <alvyjudy@gmail.com>2020-10-07 17:43:14 -0400
committeralvy <alvyjudy@gmail.com>2020-10-07 17:43:14 -0400
commita3aafcd7f572ee56c8b43e2d1d60cd252483a02f (patch)
tree349cdac89de5b1c0cabefaf613d4cbff27b0de0b /docs
parentf67c1b099d24a37a0c65bf08f88cb46e261d2a61 (diff)
downloadpython-setuptools-git-a3aafcd7f572ee56c8b43e2d1d60cd252483a02f.tar.gz
add a paragraph in index to linkt build_meta doc
Diffstat (limited to 'docs')
-rw-r--r--docs/userguide/index.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index abee331a..8470e268 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -10,6 +10,15 @@ packages.
Packages built and distributed using ``setuptools`` look to the user like
ordinary Python packages based on the ``distutils``.
+Transition to PEP517
+====================
+
+Since setuptools no longer serves as the default build tool, one must explicitly
+opt in (by providing a ``pyproject.toml`` file) to use this library. The user
+facing part is provided by `PEP517 <https://pypi.org/project/pep517/>`_ and
+backend interface is described :ref:`in this document <../build_meta>`. The
+quickstart provides an overview of the new workflow.
+
.. toctree::
:maxdepth: 1