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.

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

Added a section on checking RST markup #554

Merged
merged 2 commits into from Sep 24, 2018

Conversation

Projects
None yet
3 participants
@jwodder
Copy link
Contributor

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

This comment has been minimized.

Copy link
Member

theacodes commented Sep 17, 2018

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

@di

This comment has been minimized.

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

This comment has been minimized.

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.

@di

di approved these changes Sep 17, 2018

Copy link
Member

di left a comment

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

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jwodder jwodder deleted the jwodder:check-readme branch Sep 24, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment