如何确保README.rst有效？

Question

我的小工具有两个版本：

• https://pypi.python.org/pypi/tbzuploader/2017.11.0
• https://pypi.python.org/pypi/tbzuploader/2017.12.0错误：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，bumpversion，上传到pypi：https : //github.com/guettli/github-travis-bumpversion-
pypi

我如何确保不再释放任何损坏的README.rst？换句话说，我想避免pypi页面看起来丑陋。

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

Answer 1

更新资料

从2018年9月21日开始，Python包装管理局建议使用替代命令twine check。要安装麻线：

pip install twine
twine check dist/*

请注意，需要readme_renderer使用麻线。您仍然可以使用readme_renderer，并且仅在需要使用twine的其他功能时才需要安装twine，无论如何，如果要发布到PyPI，这都是一个好主意。

---

从官方的Python包装文档中，将您的项目上传到PyPI：

提示： 在PyPI上使用的reStructuredText解析器 不是
Sphinx！此外，为了确保所有用户的安全，禁止或删除某些种类的URL和指令（例如，.. raw::指令）。 在 尝试上传您的发行版
之前 ，您应该检查一下所提供的简短描述setup.py是否有效。您可以按照pypa /
readme_renderer工具的说明进行操作。

从该工具的README.rst：

要在本地检查详细说明，只需readme_renderer使用以下方法安装库：

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