diff --git a/changelog.d/2932.doc.1.rst b/changelog.d/2932.doc.1.rst new file mode 100644 index 0000000000..fd547d1642 --- /dev/null +++ b/changelog.d/2932.doc.1.rst @@ -0,0 +1,2 @@ +Removed the deprecated ``data_files`` option from the example in the +declarative configuration docs -- by :user:`abravalheri` diff --git a/changelog.d/2932.doc.2.rst b/changelog.d/2932.doc.2.rst new file mode 100644 index 0000000000..2b341c097f --- /dev/null +++ b/changelog.d/2932.doc.2.rst @@ -0,0 +1,3 @@ +Change type of ``data_files`` option from ``dict`` to ``section`` in +declarative configuration docs (to match previous example) -- by +:user:`abravalheri` diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index abafe37684..d1c25df197 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 ==============================