ReST formatting fails, and there is no way to see why
I just uploaded a new pyramid_sqlalchemy package to PyPI. Looking at the distribution page PyPI is not rendering ReST. I can’t figure out why. To debug this I all known (as far as I am aware) ways to debug this:
- I ran
python setup.py check, which showed no errors.
- I ran
python setup.py --long-description | rst2html-2.7.py > /dev/null. This also did not show any errors.
- I copied the description manually from the PKG-INFO file in the sdist and ran rst2html on that. That also did not show any errors.
As an uploader to PyPI this is very frustrating. It would be very useful if PyPI can report any errors it finds in descriptions. I don't quite care how this is done. Possible options are:
- when registering a distribution release with
python setup.py registerreturn all ReST errors so they are shown immediately when uploading.
- email any ReST rendering errors after an upload to the uploader. Perhaps email it to all uploaders in case uploading happens using a role account for which email is never read.
- show it in the web UI when updating the distribution information manually. This is slightly awkward since it requires an actual manual step to re-save the data without changing anything.
I don't think coming up with a way to run the syntax checks on a developer's machine, for example by creating a package which mimics PyPI's behaviour, as a workable approach: there is too much opportunity for environment changes (things like locale settings) and different package versions to lead to the wrong results.