Skip to content
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.

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

update pyproject readme docs #5158

Merged
Changes from 5 commits
Commits
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
21 changes: 18 additions & 3 deletions docs/pyproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,27 @@ maintainers = [

## readme

The readme file of the package. **Optional**
The path, or array of paths, to the readme file(s) of the package. **Optional**
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved

The file can be either `README.rst` or `README.md`.
The file can be any format, but if you intend to publish to PyPI keep the
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved
[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`.
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved

The file contents becomes the
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved
[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.
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved

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

```toml
readme = "README.md" # or "README.rst"
[tool.poetry]
# ...
readme = ["docs/README1.md", "docs/README2.md"]
```

## homepage
Expand Down