Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
python-poetry
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open
python-poetry
Commits
5c60dace
Unverified
Commit
5c60dace
authored
Jun 01, 2022
by
Patrick Ryan
Committed by
GitHub
Jun 01, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: update for multiple README and universal README format support (#5158)
Co-authored-by: Bjorn Neergaard <bjorn@neersighted.com>
parent
51824fc1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
3 deletions
+20
-3
docs/pyproject.md
+20
-3
No files found.
docs/pyproject.md
View file @
5c60dace
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment