diff options
| -rw-r--r-- | docs/userguide/declarative_config.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 7 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index c12f87bf..3ef7b074 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -166,6 +166,12 @@ 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. + Metadata -------- diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 88a6119a..cc811ed7 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -210,6 +210,13 @@ Also note that the file format for specifying dependencies resembles a ``require however please keep in mind that all non-comment lines must conform with :pep:`508` (``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. + ---- .. rubric:: Notes |