Skip to content

Commit

Permalink
Add long_description_content_type to setup.py
Browse files Browse the repository at this point in the history
The new PyPI code discards long_description when it's not valid ReStructuredText.  Luckily it also supports Markdown, but you have to [specify the content type](https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py) explicitly in that case.

(IIRC for this to work correctly you also have to use sufficiently recent versions of setuptools and twine to upload releases.)

Should fix #303.
  • Loading branch information
mgedmin committed Jun 12, 2018
1 parent 6f42433 commit 21dbf00
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
version=versioneer.get_version(),
description="Securely transfer data between computers",
long_description=open('README.md', 'rU').read(),
long_description_content_type='text/markdown',
author="Brian Warner",
author_email="warner-magic-wormhole@lothar.com",
license="MIT",
Expand Down

0 comments on commit 21dbf00

Please sign in to comment.