关于Github和PyPi的自述文件

Question

我在pypi和github上有我的python库。其中只有一个README文件是README.md，它在github上正确显示。但是在pypi它没有，它显示为纯文本。怎么来，我能做些什么呢？

最好不涉及第三方库，例如Pandoc。

Answer 1

请参阅this posting。

引用相关部分：

  

PyPI上的每个包都需要在目录的根目录下有一个名为setup.py的文件。如果您使用降价格式的自述文件，您还需要一个setup.cfg文件。

     

setup.cfg

     

这告诉PyPI您的README文件在哪里。

     

    

[元数据]

         

description-file = README.md

  

     

如果您使用降价自述文件，则必须执行此操作。在上传时，您可能仍然会遇到一些关于缺少自述文件的错误 - 不用担心。如果您不必使用降价自述文件，我建议您使用reStructuredText（REST）。