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

milksnake long description markdown is not properly rendered on pypi #18

Closed
kwlzn opened this issue Jun 12, 2018 · 2 comments
Closed

milksnake long description markdown is not properly rendered on pypi #18

kwlzn opened this issue Jun 12, 2018 · 2 comments

Comments

@kwlzn
Copy link
Contributor

kwlzn commented Jun 12, 2018

seen here: https://pypi.org/project/milksnake/#description

image

per the internet:

As of March 16, 2018, PyPI.org aka Warehouse (finally) supports Markdown in long descriptions. Warehouse replaced the old legacy PyPI implementation in April 2018.

You need to:

 - Make sure setuptools is upgraded to version 38.6.0 or newer
 - Make sure twine is upgraded to version 1.11.0 or newer
 - Make sure wheel is upgraded to version 0.31.0 or newer
 - Add a new field named long_description_content_type to your setup() call, and set it to 'text/markdown':

setup(
    long_description="""# Markdown supported!\n\n* Cheer\n* Celebrate\n""",
    long_description_content_type='text/markdown',
    # ....
)

- Use twine to upload your distribution to PyPI.
@kwlzn
Copy link
Contributor Author

kwlzn commented Jun 12, 2018

a super quick PR for the setup.py change here: #19

@mitsuhiko
Copy link
Member

This should be fixed with #19 I believe.

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

2 participants