From 661c3b6067ba2cf5407ab3aa06b36f0cbabeaf3e Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Sat, 6 Aug 2022 18:04:25 +0100 Subject: quickstart docs: Add comment about optional `packages.find` --- docs/userguide/quickstart.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/userguide') diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index e45bde0e..8bafc618 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -176,6 +176,7 @@ found, as shown in the example below: # OR [tool.setuptools.packages.find] + # All the following settings are optional: where = ["src"] # ["."] by default include = ["mypackage*"] # ["*"] by default exclude = ["mypackage.tests*"] # empty by default @@ -189,6 +190,7 @@ found, as shown in the example below: packages = find: # OR `find_namespaces:` if you want to use namespaces [options.packages.find] # (always `find` even if `find_namespaces:` was used before) + # This section is optional as well as each of the following options: where=src # . by default include=mypackage* # * by default exclude=mypackage.tests* # empty by default @@ -202,6 +204,7 @@ found, as shown in the example below: setup( # ... packages=find_packages( + # All keyword arguments below are optional: where='src', # '.' by default include=['mypackage*'], # ['*'] by default exclude=['mypackage.tests'], # empty by default -- cgit v1.2.1