python - github 上 Python 包的自述文件的格式是什么？

Question

setup.py 中的 Python distutils 在根目录下查找 README 和 README.txt一套。 github 识别像 README.md 和 README.rst 这样的格式。如何编写一个满足两者的格式化根级自述文件？

我在这里看到的唯一建议是运行 Pandoc在格式之间进行转换。如果可能，我想避免添加额外的构建步骤。

有什么方法可以告诉 distutils“使用我的 README.rst”吗？

或者，当我运行 python setup.py sdist 时忽略此警告是否会产生不良影响？

warning: sdist: standard file not found: should have one of README, README.txt

附言。我正在使用 distutils.core 因为 Google 引导我 here .过时了吗？

Answer 1

看起来答案是使用 setuptools 而不是 distutils.core。如果你关注setuptools instructions您可以了解如何将默认的 README 文件设为 .rst 文件。