Skip to content

Commit 4305841

Browse files
committed
Docs: Modify table for tool.setuptools.dynamic to mention content-type
1 parent ac9d7d2 commit 4305841

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
@@ -187,13 +187,19 @@ of all given files and concatenate them in a single string.
187187
Key Directive Notes
188188
========================== =================== =================================================================================================
189189
``version`` ``attr``, ``file``
190-
``readme`` ``file``
191-
``description`` ``file`` One-line text
190+
``readme`` ``file`` Here you can also set ``"content-type"``:
191+
192+
``readme = {file = ["README", "USAGE"], content-type = "text/plain"}``
193+
194+
If ``content-type`` is not given, ``"text/x-rst"`` is used by default.
195+
``description`` ``file`` One-line text (no line breaks)
192196
``classifiers`` ``file`` Multi-line text with one classifier per line
193197
``entry-points`` ``file`` INI format following :doc:`PyPUG:specifications/entry-points`
194198
(``console_scripts`` and ``gui_scripts`` can be included)
195-
``dependencies`` ``file`` ``requirements.txt`` format (``#`` comments and blank lines excluded) **BETA**
196-
``optional-dependencies`` ``file`` ``requirements.txt`` format per group (``#`` comments and blank lines excluded) **BETA**
199+
``dependencies`` ``file`` *subset* of the ``requirements.txt`` format
200+
(``#`` comments and blank lines excluded) **BETA**
201+
``optional-dependencies`` ``file`` *subset* of the ``requirements.txt`` format per group
202+
(``#`` comments and blank lines excluded) **BETA**
197203
========================== =================== =================================================================================================
198204

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

0 commit comments

Comments
 (0)