reStructuredText：README.rst没有解析PyPI

Question

我有一个托管在Github和PyPI上的Python项目。

在Github上：https://github.com/sloria/TextBlob/blob/master/README.rst

关于PyPi：https://pypi.python.org/pypi/textblob

我的README.rst似乎没有在PyPI上正确格式化，但它在Github上看起来很好。

我已阅读this，但我没有任何页内链接，所以这不是问题。

Answer 1

您正在使用较新的文字角色:code:。

PyPI似乎只支持docutils 0.8，直接将code和code-block添加到PyPI解析器，这意味着:code: 不支持。 / p>

GitHub使用较新版本的docutils（0.9或0.10）。

完全删除:code:：

:code:`sentiment`

使用：

`sentiment`

等

Answer 2

对于package I uploaded recently，问题是我们的贡献指南README.rst中的相对链接（不是页内链接）renders fine on GitHub，但是在PyPI上提升了渲染率

要解决此问题，我暂时将链接转换为名为

的绝对链接

python setup.py register

更新元数据并在不提交的情况下撤销更改。

Answer 3

将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 将其转换为重组文本。

确保在编写README时牢记这些。