Skip to content

Commit

Permalink
Merge pull request #347 from vanschelven/fix-329-document-filefinders
Browse files Browse the repository at this point in the history
fix #329 - document the file_finders entry point
  • Loading branch information
RonnyPfannschmidt authored Jul 19, 2019
2 parents b5f79dc + d13ceaf commit 41c8ebc
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------

Expand Down

0 comments on commit 41c8ebc

Please sign in to comment.