diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2021-11-17 21:17:32 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-05 09:14:33 +0000 |
| commit | 4ac3ec5fef406b4bb5011455a4cf840e3dbf648e (patch) | |
| tree | 11d72d95ce042dca5d40eb3bd2ba430ba23db85e /docs | |
| parent | 5d4ce7df84cc92d316934083bf50ecfc30ee6b83 (diff) | |
| download | python-setuptools-git-4ac3ec5fef406b4bb5011455a4cf840e3dbf648e.tar.gz | |
Improve text in package discovery docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/package_discovery.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst index a6b5061c..5a9a468e 100644 --- a/docs/userguide/package_discovery.rst +++ b/docs/userguide/package_discovery.rst @@ -39,7 +39,7 @@ included manually in the following manner: ) This can get tiresome really quickly. To speed things up, you can rely on -setuptools automatic discovery, or use the provided functions, as explained in +setuptools automatic discovery, or use the provided tools, as explained in the following sections. @@ -88,12 +88,12 @@ flat-layout (also known as "adhoc"): it can be can be more error-prone (e.g. during tests or if you have a bunch of folders or Python files hanging around your project root) -There is also a variation of the *flat-layout* for utilities/libraries that can -be implemented with a single Python file: +There is also a handy variation of the *flat-layout* for utilities/libraries +that can be implemented with a single Python file: single-module approach (or "few top-level modules"): - This Python files are placed directly under the project root, - instead of inside a package folder:: + Modules are placed directly under the project root, instead of inside + a package folder:: project_root_directory ├── pyproject.toml @@ -103,7 +103,7 @@ single-module approach (or "few top-level modules"): Setuptools will automatically scan your project directory looking for these layouts and try to guess the correct values for the :doc:`packages -<userguide/declarative_config>` and :doc:`py_modules <keywords>`. +<userguide/declarative_config>` and :doc:`py_modules <keywords>` configuration. To avoid confusion, file and folder names that are used by popular tools (or that correspond to well-known conventions, such as distributing documentation @@ -123,14 +123,14 @@ Also note that you can customise your project layout by explicitly setting place. -Using setuptools functions -========================== +Custom discovery +================ If the automatic discovery does not work for you (e.g., you want to *include* in the distribution top-level packages with reserved names such as ``tasks``, ``example`` or ``docs``, or you want to -*exclude* nested packages that would be otherwise included), you can set up -setuptools to use special functions for the package discovery: +*exclude* nested packages that would be otherwise included), you can use +the provided tools for package discovery: .. tab:: setup.cfg |
