Skip to content

Commit 2a89d67

Browse files
committed
Merge: Docs: Modify table for tool.setuptools.dynamic to mention content-type (#3764)
2 parents 8019ad7 + 4305841 commit 2a89d67

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/userguide/pyproject_config.rst

+10-4
Original file line numberDiff line numberDiff line change
@@ -190,13 +190,19 @@ of all given files and concatenate them in a single string.
190190
Key Directive Notes
191191
========================== =================== =================================================================================================
192192
``version`` ``attr``, ``file``
193-
``readme`` ``file``
194-
``description`` ``file`` One-line text
193+
``readme`` ``file`` Here you can also set ``"content-type"``:
194+
195+
``readme = {file = ["README", "USAGE"], content-type = "text/plain"}``
196+
197+
If ``content-type`` is not given, ``"text/x-rst"`` is used by default.
198+
``description`` ``file`` One-line text (no line breaks)
195199
``classifiers`` ``file`` Multi-line text with one classifier per line
196200
``entry-points`` ``file`` INI format following :doc:`PyPUG:specifications/entry-points`
197201
(``console_scripts`` and ``gui_scripts`` can be included)
198-
``dependencies`` ``file`` ``requirements.txt`` format (``#`` comments and blank lines excluded) **BETA**
199-
``optional-dependencies`` ``file`` ``requirements.txt`` format per group (``#`` comments and blank lines excluded) **BETA**
202+
``dependencies`` ``file`` *subset* of the ``requirements.txt`` format
203+
(``#`` comments and blank lines excluded) **BETA**
204+
``optional-dependencies`` ``file`` *subset* of the ``requirements.txt`` format per group
205+
(``#`` comments and blank lines excluded) **BETA**
200206
========================== =================== =================================================================================================
201207

202208
Supporting ``file`` for dependencies is meant for a convenience for packaging

0 commit comments

Comments
 (0)