diff options
author | Klaas van Schelven <klaas@vanschelven.com> | 2019-07-18 20:31:23 +0200 |
---|---|---|
committer | Klaas van Schelven <klaas@vanschelven.com> | 2019-07-19 10:39:55 +0200 |
commit | d13ceaf90e96288a4b9d6734379c5d20c873f2c9 (patch) | |
tree | 85decf460e67373a9a1f64ed9704cf3426ca3935 | |
parent | b5f79dc9af96892d48243c45a3583c0b2ea4f480 (diff) | |
download | setuptools-scm-d13ceaf90e96288a4b9d6734379c5d20c873f2c9.tar.gz |
fix #329 - document the file_finders entry point
-rw-r--r-- | README.rst | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -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 +<https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files>`_ +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 +<https://setuptools.readthedocs.io/en/latest/setuptools.html#adding-support-for-revision-control-systems>`_ +entry point. + + Configuration parameters ------------------------ |