diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-11 17:46:23 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-11 17:46:23 +0000 |
| commit | 4305841ac8857b6095aae1110394c7bb67f4447c (patch) | |
| tree | 4baa25f6a892d711399ccf32effb1a62b7e66fc5 | |
| parent | ac9d7d204f6a49db4e70a5880c420dcb5c509081 (diff) | |
| download | python-setuptools-git-4305841ac8857b6095aae1110394c7bb67f4447c.tar.gz | |
Docs: Modify table for tool.setuptools.dynamic to mention content-type
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index cc811ed7..33153567 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -187,13 +187,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 |