Commit 5c60dace by Patrick Ryan Committed by GitHub

docs: update for multiple README and universal README format support (#5158)

Co-authored-by: Bjorn Neergaard <bjorn@neersighted.com>
parent 51824fc1
...@@ -106,12 +106,29 @@ maintainers = [ ...@@ -106,12 +106,29 @@ maintainers = [
## readme ## readme
The readme file of the package. **Optional** A path, or list of paths corresponding to the README file(s) of the package.
**Optional**
The file can be either `README.rst` or `README.md`. 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`.
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]
# ...
readme = "README.md"
```
```toml ```toml
readme = "README.md" # or "README.rst" [tool.poetry]
# ...
readme = ["docs/README1.md", "docs/README2.md"]
``` ```
## homepage ## homepage
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment