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.

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

Jump to bottom

README.md should be renamed to README.rst #207

Open
frodo821 opened this issue Jul 1, 2020 · 1 comment · May be fixed by #213
Open

README.md should be renamed to README.rst #207

frodo821 opened this issue Jul 1, 2020 · 1 comment · May be fixed by #213

Comments

@frodo821
Copy link

frodo821 commented Jul 1, 2020 •
edited

Since PyPI compatible readme is formatted in reStructuredText and PyPI cannot render markdown document correctly, you had fixed readme to be formatted in reStructuredText (about issue #137).

Then the file extension of reStructuredText is .rst, but the file name is still README.md.

In addition, GitHub can render reStructuredText correctly if the file extension is .rst, therefore I think the document should be renamed.
@Pioverpie Pioverpie linked a pull request Oct 29, 2020 that will close this issue
Open
@Querela
Copy link

Querela commented Mar 24, 2021

Markdown can work, see: https://packaging.python.org/guides/making-a-pypi-friendly-readme/
It just requires the correct content type to be specified.
But you should/can just check before uploading:

twine check dist/*.

Also mentioned: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename README.md to README.rst Pioverpie/ebooklib
2 participants
@Querela @frodo821