Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown or reStructuredText for Readme? #43

Open
RussBaz opened this issue Jun 11, 2017 · 2 comments
Open

Markdown or reStructuredText for Readme? #43

RussBaz opened this issue Jun 11, 2017 · 2 comments

Comments

@RussBaz
Copy link
Owner

RussBaz commented Jun 11, 2017

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
Copy link
Contributor

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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants