From 2e368572607c89759e35deb06dc2a07f37d3d2bf Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Mon, 13 Jun 2022 09:20:52 +0100 Subject: Add note about availability of entry-points --- docs/userguide/extension.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'docs/userguide') diff --git a/docs/userguide/extension.rst b/docs/userguide/extension.rst index 493075b4..f1dce94b 100644 --- a/docs/userguide/extension.rst +++ b/docs/userguide/extension.rst @@ -15,11 +15,21 @@ A simple way of doing that is to hook in new or existing commands and ``setup()`` arguments just by defining "entry points". These are mappings from command or argument names to a specification of where to import a handler from. (See the section on :ref:`Dynamic Discovery of -Services and Plugins` for some more background on entry points.) +Services and Plugins` for some more background on entry points). The following sections describe the most common procedures for extending the ``distutils`` functionality used by ``setuptools``. +.. important:: + Any entry-point defined in your ``setup.cfg``, ``setup.py`` or + ``pyproject.toml`` files are not immediately available for use. Your + package needs to be installed first, then ``setuptools`` will be able to + access these entry points. For example consider a ``Project-A`` that + defines entry points. When building ``Project-A``, these will not be + available. If ``Project-B`` declares a :doc:`build system requirement + ` on ``Project-A``, then ``setuptools`` + will be able to use ``Project-A``' customizations. + Customizing Commands -------------------- -- cgit v1.2.1