← 返回首页
Added a section on checking RST markup by jwodder · Pull Request #554 · pypa/packaging.python.org · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Added a section on checking RST markup#554

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

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

Conversation

Copy link
Copy Markdown
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.

Copy link
Copy Markdown
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?

Copy link
Copy Markdown
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?

Copy link
Copy Markdown
Contributor Author

jwodder commented Sep 17, 2018

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

di approved these changes Sep 17, 2018
View reviewed changes
Copy link
Copy Markdown
Member

di left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

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

di mentioned this pull request Sep 21, 2018
Merged
theacodes merged commit 6eb4b57 into pypa:master Sep 24, 2018
jwodder deleted the check-readme branch September 24, 2018 16:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

di di approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Footer

© 2026 GitHub, Inc.