search

RussBaz / enforce

Python 3.5+ runtime type checking for integration testing and data validation
543 stars 21 forks source link

Markdown or reStructuredText for Readme? #43

Open RussBaz opened 7 years ago

RussBaz commented 7 years ago

PyPi does not support markdown descriptions.

There are two options:

  1. Replace md Readme with rst one
  2. Add some kind of build step to compile ms to rst on wheel build

Which one to choose . . .

TheDataLeek commented 7 years ago

I honestly prefer keeping the README in markdown. I wouldn't imagine it being too hard to use a tool like Pandoc to convert the markdown to rst. I've used pandoc a ton and it works great for those sort of things.

ken-morel commented 1 month ago

PyPi does not support markdown descriptions.

There are two options:

  1. Replace md Readme with rst one
  2. Add some kind of build step to compile ms to rst on wheel build

Which one to choose . . .

pypi does support markdown descriptions just as reStructuredText descriptions, simply set the description content type to text/markdown, of just view those pull requests as #82 Whatevet I am volonteer to do the markdown to reStructuredText translation.