diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-17 11:32:48 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-17 11:32:48 +0000 |
| commit | c4c8fd1e5704d22199026be12d4a7fe959295bd6 (patch) | |
| tree | bb2d46be024a724df4fe76404102e31072cdc980 /docs/userguide | |
| parent | c627a367ea62245631ba203096bd5a961851a42e (diff) | |
| download | python-setuptools-git-c4c8fd1e5704d22199026be12d4a7fe959295bd6.tar.gz | |
Improve data files section in quickstart
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/quickstart.rst | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 7a02d20b..f8e5cc64 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -290,10 +290,34 @@ are placed in a platform-specific location. Setuptools offers three ways to specify data files to be included in your packages. For the simplest use, you can simply use the ``include_package_data`` keyword: -.. code-block:: ini +.. tab:: setup.cfg + + .. code-block:: ini + + [options] + include_package_data = True + +.. tab:: setup.py + + .. code-block:: python + + setup( + # ... + include_package_data=True, + # ... + ) + +.. tab:: pyproject.toml + + **EXPERIMENTAL** [#experimental]_ + + .. code-block:: toml - [options] - include_package_data = True + [tool.setuptools] + include-package-data = true + # This is already the default behaviour if your are using + # pyproject.toml to configure your build. + # You can deactivate that with `include-package-data = false` This tells setuptools to install any data files it finds in your packages. The data files must be specified via the distutils' |MANIFEST.in|_ file |
