Joined December 2011
·
Matt Hickford
Cambridge, UK
·
Posted to
Use Markdown README's in Python modules
over 1 year
ago
Clever workaround, but the best solution would be to petition PyPI to support Markdown (as well as Restructured Text). It's a pervasive format, used on Github and StackOverflow. It shouldn't be necessary to learn a new markup language or rewrite your documentation to publish a Python package.
Npm (the Nodejs) package manager and its registry support Markdown readmes. See, for example, https://www.npmjs.org/package/yargs
If you would like PyPI to support Markdown readmes, please comment on the feature request at https://bitbucket.org/pypa/pypi/issue/148/support-markdown-for-readmes