Skip to content

Commit

Permalink
Merge: Docs: Modify table for tool.setuptools.dynamic to mention cont…
Browse files Browse the repository at this point in the history
…ent-type (#3764)
  • Loading branch information
abravalheri committed Jan 11, 2023
2 parents 8019ad7 + 4305841 commit 2a89d67
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/userguide/pyproject_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,19 @@ of all given files and concatenate them in a single string.
Key Directive Notes
========================== =================== =================================================================================================
``version`` ``attr``, ``file``
``readme`` ``file``
``description`` ``file`` One-line text
``readme`` ``file`` Here you can also set ``"content-type"``:

``readme = {file = ["README", "USAGE"], content-type = "text/plain"}``

If ``content-type`` is not given, ``"text/x-rst"`` is used by default.
``description`` ``file`` One-line text (no line breaks)
``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) **BETA**
``optional-dependencies`` ``file`` ``requirements.txt`` format per group (``#`` comments and blank lines excluded) **BETA**
``dependencies`` ``file`` *subset* of the ``requirements.txt`` format
(``#`` comments and blank lines excluded) **BETA**
``optional-dependencies`` ``file`` *subset* of the ``requirements.txt`` format per group
(``#`` comments and blank lines excluded) **BETA**
========================== =================== =================================================================================================

Supporting ``file`` for dependencies is meant for a convenience for packaging
Expand Down

0 comments on commit 2a89d67

Please sign in to comment.