From d13ceaf90e96288a4b9d6734379c5d20c873f2c9 Mon Sep 17 00:00:00 2001 From: Klaas van Schelven Date: Thu, 18 Jul 2019 20:31:23 +0200 Subject: [PATCH] fix #329 - document the file_finders entry point --- README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.rst b/README.rst index 9f6f1056..f5370b99 100644 --- a/README.rst +++ b/README.rst @@ -212,6 +212,21 @@ Builtin mechanisms for obtaining version numbers Git archives are not supported due to Git shortcomings +File finders: automatic inclusion of tracked package data +--------------------------------------------------------- + +By using ``setuptools_scm``, the default behavior of `include_package_data +`_ +is altered, such that all data files in packages that are tracked by your SCM +are included by default. That is: when using ``setuptools_scm``, it is not +needed to explicitly graft or include any package data in ``MANIFEST.in``. To +exclude files ``MANIFEST.in`` may still be used. + +This mechanism is implemented using a `file_finders +`_ +entry point. + + Configuration parameters ------------------------