Skip to content

Commit

Permalink
Add docs for multiple readme files support
Browse files Browse the repository at this point in the history
  • Loading branch information
wagnerluis1982 committed Nov 13, 2021
1 parent a49372a commit 8c075cd
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/pyproject.md
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

0 comments on commit 8c075cd

Please sign in to comment.