diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/declarative_config.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/development_mode.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 2 |
4 files changed, 15 insertions, 2 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/development_mode.rst b/docs/userguide/development_mode.rst index 2dc6dfbd..5378b994 100644 --- a/docs/userguide/development_mode.rst +++ b/docs/userguide/development_mode.rst @@ -247,7 +247,7 @@ More information is available on the text of :pep:`PEP 660 <660#what-to-put-in-t .. [#cwd] Techniques like the :ref:`src-layout` or tooling-specific options like `tox's changedir <https://tox.wiki/en/stable/config.html#conf-changedir>`_ - can be used to prevent such kinds of situations (chekout `this blog post + can be used to prevent such kinds of situations (checkout `this blog post <https://blog.ganssle.io/articles/2019/08/test-as-installed.html>`_ for more insights). 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 diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 13846e20..fe5c5bc2 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -299,7 +299,7 @@ Dependency management --------------------- Packages built with ``setuptools`` can specify dependencies to be automatically installed when the package itself is installed. -The example below show how to configure this kind of dependencies: +The example below shows how to configure this kind of dependencies: .. tab:: pyproject.toml |