summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2021-10-26 13:35:02 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2021-10-26 14:15:17 +0100
commit2c169ff531635bccab1f8bd0451a762bd286903c (patch)
treeea59310b0c94a6dbbb0baf553f27b4ce12982a1d /docs/userguide
parent4bce6d5a30accecc848d8e7f0dabd212bfea9475 (diff)
downloadpython-setuptools-git-2c169ff531635bccab1f8bd0451a762bd286903c.tar.gz
Remove data_files from declarative config example
According to the following references: - https://setuptools.pypa.io/en/latest/references/keywords.html - https://packaging.python.org/guides/distributing-packages-using-setuptools/#package-data the usage of ``data_files`` is deprecated. Therefore we should avoid having it in the main configuration example for declarative config.
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/declarative_config.rst12
1 files changed, 4 insertions, 8 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst
index abafe376..d1c25df1 100644
--- a/docs/userguide/declarative_config.rst
+++ b/docs/userguide/declarative_config.rst
@@ -63,13 +63,6 @@ boilerplate code in some cases.
src.subpackage1
src.subpackage2
- [options.data_files]
- /etc/my_package =
- site.d/00_default.conf
- host.d/00_default.conf
- data = data/img/logo.png, data/svg/icon.svg
- fonts = data/fonts/*.ttf, data/fonts/*.otf
-
Metadata and options are set in the config sections of the same name.
* Keys are the same as the keyword arguments one provides to the ``setup()``
@@ -222,7 +215,7 @@ package_data section [#
exclude_package_data section
namespace_packages list-comma
py_modules list-comma 34.4.0
-data_files dict 40.6.0
+data_files section 40.6.0 [#opt-4]_
======================= =================================== =============== =========
**Notes**:
@@ -250,6 +243,9 @@ data_files dict 40.6.0
The ``find_namespace:`` directive is supported since Python >=3.3.
+.. [#opt-4] ``data_files`` is deprecated and should be avoided.
+ Please check :doc:`/userguide/datafiles` for more information.
+
Compatibility with other tools
==============================