← 返回首页
encourage RST checking with readme_renderer by svenevs · Pull Request #379 · 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

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Resetting focus

encourage RST checking with readme_renderer#379

Merged
theacodes merged 1 commit into
pypa:masterfrom
svenevs:encourage-readme_renderer
Sep 15, 2017
Merged

encourage RST checking with readme_renderer#379
theacodes merged 1 commit into
pypa:masterfrom
svenevs:encourage-readme_renderer

Conversation

Copy link
Copy Markdown
Contributor

svenevs commented Sep 15, 2017

python setup.py check --restructuredtext did not report any errors, but readme_renderer explained effectively and concisely that .. raw:: directives are not allowed.

  1. I didn't know what to do for the admonition. I think it's in the right section, but there was already a note and a warning, and the pypa_theme doesn't seem to stylize tip or danger (sphinx only?).
    • I could also make it a definition list under **Tip**?
  2. Happy to change any and all verbiage. I just feel like linking to this tool directly will save a lot of people time, and reduce burden on PyPI from people who are releasing versions just to try and get the long description to show up.
    • I'll confess this was me, but internet trolling seems to reveal it's not uncommon. I can't use testpypi for some reason, so I didn't really have any options.
    • Then I happened upon this magical tool, and it told me exactly why I couldn't use it. TBH I'm surprised GitHub even let my .. raw:: html through...
  3. I specifically said "not Sphinx" because I think that's what most people assume it would be.
    • Should I link to Sphinx?
    • Should I state that it is the (golden standard) docutils parser? (is that even correct)?

Let me know if you think this is worth including, but the verbiage should change!

`python setup.py check --restructuredtext` did not report any errors, but `readme_renderer` explained effectively and concisely that `.. raw::` directives are not allowed
theacodes merged commit 5eb8f2b into pypa:master Sep 15, 2017
Copy link
Copy Markdown
Member

Thanks, @svenevs!

svenevs deleted the encourage-readme_renderer branch September 15, 2017 20:30
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
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.

2 participants

Footer

© 2026 GitHub, Inc.