如何确保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,颠倒,上传到pypi:https://github.com/guettli/github-travis-bumpversion-pypi

我怎样才能确保不再发布破坏的README.rst？换句话说,我想避免pypi页面看起来很难看.

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

Answer 1

从官方Python打包文档,将项目上传到PyPI:

提示: PyPI上使用的reStructuredText解析器不是 Sphinx!此外,为了确保所有用户的安全,禁止或删除某些类型的URL和指令(例如,twine check指令).在尝试上传您的发行版之前,您应该检查您提供的简短描述readme_renderer是否有效.您可以按照pypa/readme_renderer工具的说明执行此操作.

从该工具的README.rst:

要在本地检查您的长描述,只需使用以下命令安装readme_renderer库:

pip install twine
twine check dist/*