diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-19 19:07:42 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-19 19:12:20 +0000 |
| commit | b51282078fb09a7ce92ba65dfe8bd94dc465a26f (patch) | |
| tree | f8bf78053cc8a3db2ef9db6ad7a22cbc9dfd5618 /docs/userguide | |
| parent | bf9b14ce9fb02834e324fd12ebec3d0574d6222d (diff) | |
| download | python-setuptools-git-b51282078fb09a7ce92ba65dfe8bd94dc465a26f.tar.gz | |
Adapt note about file directive and MANIFEST.in
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/declarative_config.rst | 15 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 15 |
2 files changed, 20 insertions, 10 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index c882d379..68dd2715 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -169,11 +169,16 @@ 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:: - For versions prior to <VERSION>: 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). + + .. TODO add versionchanged with specific version when the behavior changed + + 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..c60d44df 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -220,11 +220,16 @@ 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). + + .. TODO add versionchanged with specific version when the behavior changed + + Newer versions of ``setuptools`` will automatically add these files to + the ``sdist``. ---- |