diff options
Diffstat (limited to 'docs/userguide/pyproject_config.rst')
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 0aa82dcf..9ce983b4 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -180,18 +180,18 @@ In the ``dynamic`` table, the ``attr`` directive [#directives]_ will read an attribute from the given module [#attr]_, while ``file`` will read the contents of all given files and concatenate them in a single string. -================= =================== ========================= +========================== =================== ================================================================================================= Key Directive Notes -================= =================== ========================= +========================== =================== ================================================================================================= ``version`` ``attr``, ``file`` ``readme`` ``file`` ``description`` ``file`` One-line text ``classifiers`` ``file`` Multi-line text with one classifier per line ``entry-points`` ``file`` INI format following :doc:`PyPUG:specifications/entry-points` (``console_scripts`` and ``gui_scripts`` can be included) -``dependencies`` ``file`` ``requirements.txt`` format (``#`` comments and blank lines excluded) -``optional-dependencies`` ``file`` ``requirements.txt`` format per group (``#`` comments and blank lines excluded) -========================== =================== ========================= +``dependencies`` ``file`` ``requirements.txt`` format (``#`` comments and blank lines excluded) **BETA** +``optional-dependencies`` ``file`` ``requirements.txt`` format per group (``#`` comments and blank lines excluded) **BETA** +========================== =================== ================================================================================================= Supporting ``file`` for dependencies is meant for a convenience for packaging applications with possibly strictly versioned dependencies. @@ -203,6 +203,10 @@ Currently, when specifying ``optional-dependencies`` dynamically, all of the gro must be specified dynamically; one can not specify some of them statically and some of them dynamically. +Also note that the file format for specifying dependencies resembles a ``requirements.txt`` file, +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). + ---- .. rubric:: Notes |