如何确保README.rst有效？

Question

我的小工具有两个版本：

• https://pypi.python.org/pypi/tbzuploader/2017.11.0
• https://pypi.python.org/pypi/tbzuploader/2017.12.0 Bug: pypi页面看起来很难看。

在上一次更新中，README.rst的更改是一个警告：

user@host> rst2html.py README.rst  > /tmp/foo.html
README.rst:18: (WARNING/2) Inline emphasis start-string without end-string.
README.rst:18: (WARNING/2) Inline emphasis start-string without end-string.

现在，pypi页面看起来很难看：-

我用这个菜谱来做CI，保险版，上传到pypi：https://github.com/guettli/github-travis-bumpversion-pypi

我怎样才能确保不再释放坏掉的README.rst？换句话说，我想避免那个pypi页面看起来很难看。

亲爱的细节爱好者:请不要查看当前README.rst中的特定错误。这不是问题所在:-)

Answer 1

更新

截至2018年9月21日，建议使用另一个命令twine check。转到安装麻绳

pip install twine
twine check dist/*

注意，readme_renderer。您仍然可以使用readme_renderer，如果您需要它的其他特性，您只需要安装twine，如果您要发布到PyPI，这是一个好主意。

来自官方的Python打包文档，将您的项目上载到PyPI

提示：，PyPI上使用的reStructuredText解析器是，而不是狮身人面像！此外，为了确保所有用户的安全，禁止或删除某些类型的URL和指令(例如，.. raw::指令)。在试图上载您的发行版之前，您应该检查setup.py中提供的简短/冗长的描述是否有效。您可以按照渲染器工具的说明进行操作。

从那个工具的README.rst

要在本地检查您的长描述，只需使用以下方法安装readme_renderer库：

$ pip install readme_renderer
$ python setup.py check -r -s

Answer 2

序言

我有一个自述文件，除了页面上的第一个元素(图像)之外，它不会在PyPi上呈现。我针对多个验证器运行了该文件，并对其进行了其他呈现的测试。它在其他任何地方都很好！因此，经过长时间的、令人讨厌的斗争，以及许多版本的颠簸，为了测试PyPi修订版，我尝试将文件压缩到最低限度，然后将其重新构建起来。原来的第一行总是被处理，然后没有其他的东西是.

溶液

发现第一行的线索，我顿悟.我所要做的就是更改文件中的行尾！我在Windows中编辑文件，并隐式地添加Windows行尾。我把它改成了Unix样式和(poof!)PyPi完全渲染了文档！

咆哮.

过去我遇到过这样的事情，但我认为PyPi会处理这样的跨平台问题，这是理所当然的。我的意思是Python的一个关键特性是跨平台！我是第一个在Windows工作的人遇到这种情况吗？！我不喜欢浪费这么多时间。

Answer 3

如果拉斯特查克捕捉到自述文件中的错误类型，您可以尝试。如果是，请在脚本部分的pytest之后运行它。(并将其添加到您的需求ofc中)。