Skip to content

Added a section on checking RST markup#554

Merged
theacodes merged 2 commits intopypa:masterfrom
jwodder:check-readme
Sep 24, 2018
Merged

Added a section on checking RST markup#554
theacodes merged 2 commits intopypa:masterfrom
jwodder:check-readme

Conversation

@jwodder
Copy link
Contributor

@jwodder jwodder commented Sep 16, 2018

This PR adds a section to "Making a PyPI-friendly README" describing how to use readme_renderer to check that a reStructuredText README renders correctly.

@theacodes
Copy link
Member

@di do you want me to hold on to this until we cut a new release of twine with twine check?

@di
Copy link
Member

di commented Sep 17, 2018

@theacodes Yeah, I think that makes sense.

@jwodder Would you be able to revise this to use the new twine check command?

@jwodder
Copy link
Contributor Author

jwodder commented Sep 17, 2018

PR revised. I took a guess that the twine version to recommend will be 1.12.

Copy link
Member

@di di left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We should wait until the new version is actually released to merge, of course.

@theacodes theacodes merged commit 6eb4b57 into pypa:master Sep 24, 2018
@jwodder jwodder deleted the check-readme branch September 24, 2018 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants