diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-04-11 23:16:39 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-05-16 13:35:25 +0100 |
| commit | 269f3acbf4e3a2f717fb37dc23ff48bf36b8bc2a (patch) | |
| tree | d3427e8f3133bcb0529bd254813604d221d838e9 | |
| parent | 5e404231fb0905d7e23167f957943e9a03e4ef7a (diff) | |
| download | python-setuptools-git-269f3acbf4e3a2f717fb37dc23ff48bf36b8bc2a.tar.gz | |
Add deprecation notices to docs
| -rw-r--r-- | docs/references/keywords.rst | 5 | ||||
| -rw-r--r-- | docs/userguide/declarative_config.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 2 |
3 files changed, 11 insertions, 2 deletions
diff --git a/docs/references/keywords.rst b/docs/references/keywords.rst index f231b2b8..d3663000 100644 --- a/docs/references/keywords.rst +++ b/docs/references/keywords.rst @@ -353,6 +353,11 @@ extensions). .. _keyword/namespace_packages: ``namespace_packages`` + .. warning:: + ``namespace_packages`` is deprecated in favor of native/implicit + namespaces (:pep:`420`). Check :doc:`the Python Packaging User Guide + <PyPUG:guides/packaging-namespace-packages>` for more information. + A list of strings naming the project's "namespace packages". A namespace package is a package that may be split across multiple project distributions. For example, Zope 3's ``zope`` package is a namespace diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 52379dbf..2a65e6e3 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -210,7 +210,7 @@ packages find:, find_namespace:, list-comma [# package_dir dict package_data section [#opt-1]_ exclude_package_data section -namespace_packages list-comma +namespace_packages list-comma [#opt-5]_ py_modules list-comma 34.4.0 data_files section 40.6.0 [#opt-4]_ ======================= =================================== =============== ========= @@ -243,6 +243,10 @@ data_files section 40.6.0 [# .. [#opt-4] ``data_files`` is deprecated and should be avoided. Please check :doc:`/userguide/datafiles` for more information. +.. [#opt-5] ``namespace_packages`` is deprecated in favour of native/implicit + namespaces (:pep:`420`). Check :doc:`the Python Packaging User Guide + <PyPUG:guides/packaging-namespace-packages>` for more information. + Compatibility with other tools ============================== diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 7b8f8104..8558f5d7 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -94,7 +94,7 @@ Key Value Type (TOML) Notes ``py-modules`` array See tip below ``packages`` array or ``find`` directive See tip below ``package-dir`` table/inline-table Used when explicitly listing ``packages`` -``namespace-packages`` array Not necessary if you use :pep:`420` +``namespace-packages`` array **Deprecated** - Use implicit namespaces instead (:pep:`420`) ``package-data`` table/inline-table See :doc:`/userguide/datafiles` ``include-package-data`` boolean ``True`` by default ``exclude-package-data`` table/inline-table |