【发布时间】:2015-05-25 07:46:01
【问题描述】:
我在 pypi 和 github 上有我的 python 库。其中只有一个 README 文件,即 README.md,它在 github 上正确显示。但在 pypi 上却没有,它显示为纯文本。我该怎么办?
最好不涉及 Pandoc 等第三方库。
【问题讨论】:
-
我认为没有第三方转换是做不到的。见this discussion。
我在 pypi 和 github 上有我的 python 库。其中只有一个 README 文件,即 README.md,它在 github 上正确显示。但在 pypi 上却没有,它显示为纯文本。我该怎么办?
最好不涉及 Pandoc 等第三方库。
【问题讨论】:
请参考this posting。
引用相关部分:
PyPI 上的每个包都需要在目录的根目录下有一个名为 setup.py 的文件。如果您使用的是降价格式的自述文件,您还需要一个 setup.cfg 文件。
setup.cfg
这告诉 PyPI 你的 README 文件在哪里。
[元数据]
描述文件 = README.md
如果您使用的是降价自述文件,则这是必需的。在上传时,您可能仍然会收到一些关于缺少自述文件的错误——不用担心。如果您不必使用 markdown README 文件,我建议您改用 reStructuredText (REST)。
【讨论】: