Invalid rst in README prevents PyPI from rendering as HTML

Issue #447 resolved
Éric Araujo created an issue


You need to escape asterisks (i.e. *nix) or just write Unix in README, otherwise the rst parser in docutils interprets it as the start of emphasis markup which is never closed. That’s why PyPI diplays the raw rst instead of cool HTML.

You can use rst2html to check before committing, or python check (distutils command in Python 2.7 and 3.x).


Comments (1)

  1. Log in to comment