Skip to content

update pyproject readme docs #5158

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

Merged
neersighted merged 14 commits into from
Jun 2, 2022
+20 −3
Merged

update pyproject readme docs #5158

Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
98da1b1
update pyproject readme docs
patrick-ryan Feb 6, 2022
092eea2
update pyproject readme docs, better example
patrick-ryan May 17, 2022
043bcfc
Merge branch 'master' of github.com:python-poetry/poetry into 5069-py…
patrick-ryan Jun 1, 2022
d9cb44c
update pyproject readme docs, readme array
patrick-ryan Jun 1, 2022
e75245d
update pyproject readme docs, readme any format
patrick-ryan Jun 1, 2022
cda1f41
Merge github.com:python-poetry/poetry into 5069-pyproject-readme-docs…
patrick-ryan Jun 2, 2022
9bcead8
update pyproject readme docs
patrick-ryan Jun 2, 2022
54da53e
update pyproject readme docs, rewrap 80
patrick-ryan Jun 2, 2022
f14db3f
Update docs/pyproject.md
patrick-ryan Jun 2, 2022
42fbcc4
Update docs/pyproject.md
patrick-ryan Jun 2, 2022
df8e2eb
Update docs/pyproject.md
patrick-ryan Jun 2, 2022
8908af1
Update docs/pyproject.md
patrick-ryan Jun 2, 2022
7ffd5a7
Update docs/pyproject.md
patrick-ryan Jun 2, 2022
537ad45
Merge branch '5069-pyproject-readme-docs-update' of github.com:patric…
patrick-ryan Jun 2, 2022
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
View file
Open in desktop
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**
Comment thread
patrick-ryan marked this conversation as resolved.
Outdated

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
Comment thread
patrick-ryan marked this conversation as resolved.
Outdated
[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`.
Comment thread
patrick-ryan marked this conversation as resolved.
Outdated

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

```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