python - Github 和 PyPi 上的自述文件

Question

我在 pypi 和 github 上有我的 python 库。其中只有一个 README 文件，即 README.md，并且它在 github 上正确显示。但在 pypi 上则不然，它显示为纯文本。怎么会这样？我能做什么呢？

最好不涉及 Pandoc 等第三方库。

Answer 1

请引用this posting .

引用相关部分:

Every package on PyPI needs to have a file called setup.py at the root of the directory. If your'e using a markdown-formatted read me file you'll also need a setup.cfg file.

setup.cfg

This tells PyPI where your README file is.

[metadata]

description-file = README.md

如果您使用的是 Markdown 自述文件，这是必需的。在上传时，您可能仍然会收到一些有关缺少自述文件的错误 - 不用担心。如果您不必使用 markdown README 文件，我建议您使用 reStructuredText (REST)。