summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 18:04:25 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-08-06 18:08:05 +0100
commit661c3b6067ba2cf5407ab3aa06b36f0cbabeaf3e (patch)
treeca768e1a4007f4dc362f7b0e5fb9e33a3ae16f19 /docs/userguide
parent0d3843dc44cf2ab843bea7d8e813f05effde5b2f (diff)
downloadpython-setuptools-git-661c3b6067ba2cf5407ab3aa06b36f0cbabeaf3e.tar.gz
quickstart docs: Add comment about optional `packages.find`
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/quickstart.rst3
1 files changed, 3 insertions, 0 deletions
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