Skip to content

Add docs and schema for multiple readme files support #4743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wagnerluis1982 wants to merge 2 commits into from
Closed

Add docs and schema for multiple readme files support #4743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b06302
Add docs for multiple readme files support
wagnerluis1982 Nov 13, 2021
f22529d
Update poetry-schema.json
wagnerluis1982 Nov 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,29 @@ The readme file of the package. **Optional**

The file can be either `README.rst` or `README.md`.

```toml
[tool.poetry]
# ...
readme = "README.rst"
```

If you want to use multiple readme files, you can by wrapping the files in a list.

```toml
[tool.poetry]
# ...
readme = [
"README.rst",
"CHANGELOG.rst"
]
```

{{% note %}}
Note that a line break (`\n`) will be added between each file in the generated readme.

Additionally, all the listed files must be of same type, i.e. you cannot mix `.rst` and `.md`.
{{% /note %}}

## homepage

An URL to the website of the project. **Optional**
Expand Down
15 changes: 13 additions & 2 deletions src/poetry/json/schemas/poetry-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,19 @@
"$ref": "#/definitions/maintainers"
},
"readme": {
"type": "string",
"description": "The path to the README file"
"anyOf": [
{
"type": "string",
"description": "The path to the README file."
},
{
"type": "array",
"description": "A list of paths to the readme files.",
"items": {
"type": "string"
}
}
]
},
"classifiers": {
"type": "array",
Expand Down