reStructuredText header issue

[dgasaway]

I was testing a new project (new to PyPI) by uploading to TestPyPI. I have a README.rst file that is read into long_description. The README looked fine in bitbucket, passed readme_renderer and rst-lint, but kept failing to render formatted in the project description on TestPyPI. After tinkering for hours, I chopped up the file and kept adding more pieces until the failure came back, and it came down to a header that looked like this...

From Source
-----------

And then I noticed that in the (unformatted) project description on TestPyPI, it would strangely render with a greater than symbol in front...

>From Source
-----------

I made sure there were no special characters in that position in the file. Deleted everything between this and the text before it. Looked good. Eventually, I just changed the header, and the problem went away.

[brainwane]

Hi, @dgasaway -- thanks for reporting this problem. Could you point us to the Test PyPI project that had this problem, and show us the README.rst file and the setup.py file? You can add a .txt file extension and attach those files directly to this issue.

[dgasaway]

Hi. The project is here, but note that I've since had it corrected. It looks like that last one that showed the issue was 1.0.22. You can find the README.rst here. Although I didn't keep the readme for all the uploads to TestPyPI, the final commit shows the changes that fixed it. One of the many TestPyPI uploads probably matches that earlier revision, but I'm not sure which one.

[dgasaway]

Sorry, I forgot to link to the setup.py. Thanks.

[brainwane]

@dgasaway Hi - we've now made a number of improvements to Warehouse's README rendering. Could you upgrade your packaging and distribution toolchain -- setuptools and readme_renderer in particular -- and then let us know whether a similar incongruency shows up for you when the first couple lines of README.rst are

From Source
-----------

?

[jamadden]

This reminds me of
pypa/wheel#178

[di]

Sounds similar. Perhaps we need to fix this farther upstream then, rather than in readme_renderer.

[merwok]

This might be an email parameter issue from deep down in docutils :(

[dgasaway]

If you're still looking for feedback from me (sorry), I tried it again with a new project I was working on today. Did not have a problem.

[brainwane]

Since you could not reproduce the problem, I am going to close this, @dgasaway -- thank you for the report, and glad it's resolved!

Other people in the future should feel free to re-open this if the problem recurs.