Check ReStructured Text syntax validity

Recommended: Use Markdown instead of RST for Python README


On uploading to PyPi with invalid README.rst syntax, you may get error:

HTTPError: 400 Client Error: The description failed to render in the default format of reStructuredText. See https://pypi.org/help/#description-content-type for more information. for url: https://upload.pypi.org/legacy/

Fix

I like the online RST editor/renderer rst.ninjs.org

This helps avoid crappy looking README’s seen on even major projects on PyPi.

Tags:

Categories:

Written by Michael Hirsch, Ph.D. //

Comments