python - reStructuredText:README.rst 不适用于 PyPI

Question

我在github上创建了一个包django-joyride , 在 publishing 之后它到 pypi 它没有正确显示 README.rst。我检查了我的语法 here在在线查看器上，您可以看到它工作正常。可能是什么问题？

Answer 1

我在将我的 python 模块上传到 pypi 时遇到了同样的问题。

后来我使用 rst-lint 检查了 README.rst 是否有错误，这表明我的自述文件是正确的。您还可以使用 python 的 restructuredtext_link 包来检查第一个文件是否有任何错误或警告。

我发现问题不在 README 文件中，而在 setup.py 本身。

在编写 Readme 和 setup.py 时请遵循以下几点

• 不要编写多行 python 字符串来描述或总结或任何进入 setup( ) 参数的内容。
• 不要在 README 文件中使用相对链接。(如 ./path1/path2 )。
• 使用 rst-lint 等检查工具确保 rst 语法正确。
• 如果您有 markdown 文件，您可以使用 pandoc 轻松地将其转换为重组文本。

也不要使用任何新的 docutils 语法，因为 Pypi 不像 Github 那样使用最新版本。