reStructuredText：README.rst没有在PyPI上工作

Question

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

Answer 1

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

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

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

在编写自述文件和setup.py

时，请遵循以下几点

• 请勿编写MULTI LINE python字符串以获取描述或摘要或任何进入setup（）参数的内容。
• 不要在README文件中使用相对链接。（例如./path1/path2）。
• 使用像rst-lint这样的检查工具确保第一种语法是正确的。
• 如果您有markdown文件，则可以轻松地使用 pandoc 将其转换为重组文本。

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

Answer 2

pypi可能会因为你同时拥有README.md和README.rst文件而感到困惑。尝试删除.md一个; github可以处理README.rst罚款。