From 98da1b11232017a76f92cf12c0958f316c72b988 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Sun, 6 Feb 2022 16:51:08 -0500 Subject: [PATCH 01/11] update pyproject readme docs --- docs/pyproject.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 9147294f441..e28e4748bc1 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -69,9 +69,21 @@ This is a list of maintainers and should be distinct from authors. Maintainers m ## readme -The readme file of the package. **Optional** +The path to the readme file of the package. **Optional** -The file can be either `README.rst` or `README.md`. +The file should be in either Markdown (.md) or reStructuredText (.rst) +format. The path is relative to the directory containing the +`pyproject.toml`. + +The file contents becomes the +[Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) +in a PyPI build (similar to `long_description` in setuptools). + +```toml +[tool.poetry] +# ... +readme = "./README.md" +``` ## homepage From 092eea2c3f1b7f5e7c22bd6cb05dbbf670897e1d Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Mon, 16 May 2022 22:13:29 -0400 Subject: [PATCH 02/11] update pyproject readme docs, better example --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index e28e4748bc1..f85fac56afa 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -82,7 +82,7 @@ in a PyPI build (similar to `long_description` in setuptools). ```toml [tool.poetry] # ... -readme = "./README.md" +readme = "README.md" ``` ## homepage From d9cb44c146527f6ea8b2770d1d48c2756380c147 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 18:46:43 -0400 Subject: [PATCH 03/11] update pyproject readme docs, readme array --- docs/pyproject.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index e54a2a5581e..195b27dc7fb 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -106,7 +106,7 @@ maintainers = [ ## readme -The path to the readme file of the package. **Optional** +The path, or array of paths, to the readme file(s) of the package. **Optional** The file should be in either Markdown (.md) or reStructuredText (.rst) format. The path is relative to the directory containing the @@ -114,16 +114,18 @@ format. The path is relative to the directory containing the The file contents becomes the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) -in a PyPI build (similar to `long_description` in setuptools). +in a PyPI build (similar to `long_description` in setuptools). When specifying multiple readmes, their texts will be combined, separated by newlines. ```toml [tool.poetry] # ... -readme = "README.md" +readme = "README.md" # or "README.rst" ``` ```toml -readme = "README.md" # or "README.rst" +[tool.poetry] +# ... +readme = ["docs/README1.md", "docs/README2.md"] ``` ## homepage From e75245dd0e7039a925a3c661e3778b391b9acd47 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 19:02:38 -0400 Subject: [PATCH 04/11] update pyproject readme docs, readme any format --- docs/pyproject.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 195b27dc7fb..02b52a50436 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -108,9 +108,10 @@ maintainers = [ The path, or array of paths, to the readme file(s) of the package. **Optional** -The file should be in either Markdown (.md) or reStructuredText (.rst) -format. The path is relative to the directory containing the -`pyproject.toml`. +The file can be any format, but if you intend to publish to PyPI keep the +[recommendations for a PyPI-friendly README]( +https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) +in mind. The path is relative to the directory containing the `pyproject.toml`. The file contents becomes the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) @@ -119,7 +120,7 @@ in a PyPI build (similar to `long_description` in setuptools). When specifying m ```toml [tool.poetry] # ... -readme = "README.md" # or "README.rst" +readme = "README.md" ``` ```toml From f14db3f48ab5b1672feddf0e50b0d118ed883784 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 21:34:16 -0400 Subject: [PATCH 05/11] Update docs/pyproject.md Co-authored-by: Bjorn Neergaard --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 02b52a50436..9573b3b4009 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -106,7 +106,7 @@ maintainers = [ ## readme -The path, or array of paths, to the readme file(s) of the package. **Optional** +A path, or list of paths corresponding to the README file(s) of the package. **Optional** The file can be any format, but if you intend to publish to PyPI keep the [recommendations for a PyPI-friendly README]( From 42fbcc497594570948ebdfa96fa66214cda0bec5 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 21:34:30 -0400 Subject: [PATCH 06/11] Update docs/pyproject.md Co-authored-by: Bjorn Neergaard --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 9573b3b4009..8cb07d0f1bf 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -108,7 +108,7 @@ maintainers = [ A path, or list of paths corresponding to the README file(s) of the package. **Optional** -The file can be any format, but if you intend to publish to PyPI keep the +The file(s) can be of any format, but if you intend to publish to PyPI keep the [recommendations for a PyPI-friendly README]( https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) in mind. The path is relative to the directory containing the `pyproject.toml`. From df8e2eb478cb13daf05b184f778527837fa8c11c Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 21:34:50 -0400 Subject: [PATCH 07/11] Update docs/pyproject.md Co-authored-by: Bjorn Neergaard --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 8cb07d0f1bf..52a5e0cd0c8 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -111,7 +111,7 @@ A path, or list of paths corresponding to the README file(s) of the package. **O The file(s) can be of any format, but if you intend to publish to PyPI keep the [recommendations for a PyPI-friendly README]( https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) -in mind. The path is relative to the directory containing the `pyproject.toml`. +in mind. README paths are implicitly relative to `pyproject.toml`. The file contents becomes the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) From 8908af16cb7770418eee1d31c3da8f5200e7bf33 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 21:35:04 -0400 Subject: [PATCH 08/11] Update docs/pyproject.md Co-authored-by: Bjorn Neergaard --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 52a5e0cd0c8..f9f7306be92 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -113,7 +113,7 @@ The file(s) can be of any format, but if you intend to publish to PyPI keep the https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) in mind. README paths are implicitly relative to `pyproject.toml`. -The file contents becomes the +The contents of the README file(s) are used to populate the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) in a PyPI build (similar to `long_description` in setuptools). When specifying multiple readmes, their texts will be combined, separated by newlines. From 7ffd5a7fea038ba80f5ac3429b87bc82d85c3418 Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 21:36:04 -0400 Subject: [PATCH 09/11] Update docs/pyproject.md Co-authored-by: Bjorn Neergaard --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index f9f7306be92..c72ba039499 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -115,7 +115,7 @@ in mind. README paths are implicitly relative to `pyproject.toml`. The contents of the README file(s) are used to populate the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) -in a PyPI build (similar to `long_description` in setuptools). When specifying multiple readmes, their texts will be combined, separated by newlines. +of your distribution's metadata (similar to `long_description` in setuptools). When specifying multiple files are specified, they are concatenated with newlines. ```toml [tool.poetry] From 9bcead8cd9ab81213c62aed6b7326625913a3d7b Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 20:05:35 -0400 Subject: [PATCH 10/11] update pyproject readme docs --- docs/pyproject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index c72ba039499..2f24c99c36d 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -115,7 +115,7 @@ in mind. README paths are implicitly relative to `pyproject.toml`. The contents of the README file(s) are used to populate the [Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) -of your distribution's metadata (similar to `long_description` in setuptools). When specifying multiple files are specified, they are concatenated with newlines. +of your distribution's metadata (similar to `long_description` in setuptools). When multiple files are specified, they are concatenated with newlines. ```toml [tool.poetry] From 54da53e5076a713c3bc866faffb429aea30d64ea Mon Sep 17 00:00:00 2001 From: Patrick Ryan Date: Wed, 1 Jun 2022 20:10:39 -0400 Subject: [PATCH 11/11] update pyproject readme docs, rewrap 80 --- docs/pyproject.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/pyproject.md b/docs/pyproject.md index 2f24c99c36d..7c5cc90d3af 100644 --- a/docs/pyproject.md +++ b/docs/pyproject.md @@ -106,16 +106,18 @@ maintainers = [ ## readme -A path, or list of paths corresponding to the README file(s) of the package. **Optional** +A path, or list of paths corresponding to the README file(s) of the package. +**Optional** The file(s) can be of any format, but if you intend to publish to PyPI keep the [recommendations for a PyPI-friendly README]( -https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) -in mind. README paths are implicitly relative to `pyproject.toml`. +https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) in +mind. README paths are implicitly relative to `pyproject.toml`. -The contents of the README file(s) are used to populate the -[Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) -of your distribution's metadata (similar to `long_description` in setuptools). When multiple files are specified, they are concatenated with newlines. +The contents of the README file(s) are used to populate the [Description +field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional) +of your distribution's metadata (similar to `long_description` in setuptools). +When multiple files are specified they are concatenated with newlines. ```toml [tool.poetry]