From bf9b14ce9fb02834e324fd12ebec3d0574d6222d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sinclert=20P=C3=A9rez?= Date: Thu, 12 Jan 2023 19:25:50 +0100 Subject: Update setuptools sdist docs warning --- docs/userguide/declarative_config.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/userguide') diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 6303e66f..c882d379 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -170,9 +170,9 @@ Special directives: 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``. + For versions prior to : 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. -- cgit v1.2.1 From b51282078fb09a7ce92ba65dfe8bd94dc465a26f Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Thu, 19 Jan 2023 19:07:42 +0000 Subject: Adapt note about file directive and MANIFEST.in --- docs/userguide/declarative_config.rst | 15 ++++++++++----- docs/userguide/pyproject_config.rst | 15 ++++++++++----- 2 files changed, 20 insertions(+), 10 deletions(-) (limited to 'docs/userguide') 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 : 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``. ---- -- cgit v1.2.1 From 58fa95e468242d41dd8d53e0d92429e964eaeb59 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 20 Jan 2023 11:06:39 +0000 Subject: Add versionchanged note to docs --- docs/userguide/declarative_config.rst | 6 ++---- docs/userguide/pyproject_config.rst | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) (limited to 'docs/userguide') diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 68dd2715..d5735166 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -175,10 +175,8 @@ Special directives: (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``. + .. 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 c60d44df..c97984ba 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -226,10 +226,8 @@ however please keep in mind that all non-comment lines must conform with :pep:`5 (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``. + .. versionchanged:: 66.1.0 + Newer versions of ``setuptools`` will automatically add these files to the ``sdist``. ---- -- cgit v1.2.1