根据PyPA Specifications,在上传到Pypi时应该可以使用markdown格式化的README文件。
我不太明白的是放置此配置行的位置。我怀疑它必须是PKG-INFO但是a)它不起作用(我在setup.py dist
之后手动添加)和b)我认为它不打算手动添加。
我还做的是在Manifest.in中添加README.md
include README.md
并在setup.cfg中指定它:
[metadata]
description-file = README.md
你可以看看我的回购here。
但是,pypi上没有显示任何内容,就好像没有自述文件一样。
我完全清楚RST是推荐的方式,网上的大多数内容都是关于如何将MD转换为RST,这对我来说也不起作用(可能是由于RST版本不兼容)。根据this blog post和提到的PyPA Specifications应该可以使用降价,我非常希望这样做。