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.

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

encourage RST checking with readme_renderer #379

merged 1 commit into from Sep 15, 2017

encourage RST checking with readme_renderer #379

merged 1 commit into from Sep 15, 2017


Copy link

@svenevs svenevs commented Sep 15, 2017

python 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 check --restructuredtext` did not report any
errors, but `readme_renderer` explained effectively and
concisely that `.. raw::` directives are not allowed
@theacodes theacodes merged commit 5eb8f2b into pypa:master Sep 15, 2017
1 check was pending
Copy link

theacodes commented Sep 15, 2017

Thanks, @svenevs!

@svenevs svenevs deleted the encourage-readme_renderer branch Sep 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants