diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-20 11:11:24 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-20 11:11:24 +0000 |
| commit | cf9351dee7e8ec475468f83ecfb2e5f2de1b0ebe (patch) | |
| tree | 106b027d2918b10c715677dd1a85b9bd16477931 /docs/userguide | |
| parent | ca3198a52d48123d4d8e67952f1c9d5abba38d1f (diff) | |
| parent | 58fa95e468242d41dd8d53e0d92429e964eaeb59 (diff) | |
| download | python-setuptools-git-cf9351dee7e8ec475468f83ecfb2e5f2de1b0ebe.tar.gz | |
Automatically add files referenced by configuration to sdist (#3779)
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/declarative_config.rst | 13 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 13 |
2 files changed, 16 insertions, 10 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 6303e66f..d5735166 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -169,11 +169,14 @@ Special directives: The ``file:`` directive is sandboxed and won't reach anything outside the project directory (i.e. the directory containing ``setup.cfg``/``pyproject.toml``). - .. attention:: - When using the ``file:`` directive, please make sure that all necessary - files are included in the ``sdist``. You can do that via ``MANIFEST.in`` - or using plugins such as ``setuptools-scm``. - Please have a look on :doc:`/userguide/miscellaneous` for more information. + .. note:: + If you are using an old version of ``setuptools``, you might need to ensure + that all files referenced by the ``file:`` directive are included in the ``sdist`` + (you can do that via ``MANIFEST.in`` or using plugins such as ``setuptools-scm``, + please have a look on :doc:`/userguide/miscellaneous` for more information). + + .. versionchanged:: 66.1.0 + Newer versions of ``setuptools`` will automatically add these files to the ``sdist``. Metadata diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 633f4de7..c97984ba 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -220,11 +220,14 @@ however please keep in mind that all non-comment lines must conform with :pep:`5 (``pip``-specify syntaxes, e.g. ``-c/-r/-e`` flags, are not supported). -.. attention:: - When using the ``file`` directive, please make sure that all necessary - files are included in the ``sdist``. You can do that via ``MANIFEST.in`` - or using plugins such as ``setuptools-scm``. - Please have a look on :doc:`/userguide/miscellaneous` for more information. +.. note:: + If you are using an old version of ``setuptools``, you might need to ensure + that all files referenced by the ``file`` directive are included in the ``sdist`` + (you can do that via ``MANIFEST.in`` or using plugins such as ``setuptools-scm``, + please have a look on :doc:`/userguide/miscellaneous` for more information). + + .. versionchanged:: 66.1.0 + Newer versions of ``setuptools`` will automatically add these files to the ``sdist``. ---- |