[Distutils] PyPI not rendering ReST long_description

[Chris Jerdonek]

On Sun, Jul 13, 2014 at 1:35 PM, Wichert Akkerman <wichert at wiggy.net> wrote:
>
> On 13 Jul 2014, at 21:36, Chris Jerdonek <chris.jerdonek at gmail.com> wrote:
>
> On Sun, Jul 13, 2014 at 9:04 AM, Wichert Akkerman <wichert at wiggy.net> wrote:
>
> I just uploaded a new pyramid_sqlalchemy package to PyPI. Looking at the
> distribution page at https://pypi.python.org/pypi/pyramid_sqlalchemy PyPI is
> not rendering ReST. I can’t figure out why though: according to both “python
> setup.py check” and "python setup.py --long-description | rst2html-2.7.py >
> /dev/null” there are no ReST syntax errors in me description. Is there any
> way to see why PyPI is not rendering my ReST?
>
>
> I filed a PyPI issue about this some time before July 2012.
>
> It bothers me that I can't seem to find the issue listed on the
> current PyPI issues page: https://bitbucket.org/pypa/pypi/issues .  It
> also disturbs me that I can't seem to find the issue on the old
> SourceForge page either: http://sourceforge.net/projects/pypi/ .
>
>
> That is somewhat worrying. I created a new ticket for this:
> https://bitbucket.org/pypa/pypi/issue/161/rest-formatting-fails-and-there-is-no-way
>
>
> 3) The user should have some way of running the conversion locally (as
> a check), using the same rules as PyPI, so the user can be assured in
> advance that the conversion will be successful when interacting with
> the real PyPI.
>
>
> I don’t believe that is a viable approach. I suspect there is a reasonable
> risk that environment changes between PyPI and your local system, for
> example environment settings or available locals, and using different
> versions of packages such as docutils will lead to incorrect results. There
> really is no substitute for PyPI itself reporting errors it finds.

I was suggesting this in addition to PyPI reporting errors and not as
a substitute.  It shouldn't be necessary to interact with a remote
service when developing locally to validate and check for errors.

--Chris