如何确保这一点自述文件.rst是否有效?

2024-03-29 08:28:41 发布

您现在位置:Python中文网/ 问答频道 /正文

我的小工具有两个版本:

在上次更新中自述文件.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

我怎么能保证不坏呢自述文件.rst还会被释放吗?换句话说,我想避免pypi页面看起来很难看。在

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


Tags: httpsorgpypistring错误inline自述文件页面
3条回答

序言

我有一个自述文件,除了页面上的第一个元素(图像)之外,它不会在PyPi上呈现。我在多个验证器上运行了这个文件,并在其他渲染器上进行了测试。它在其他地方都很好用!因此,在与它进行了长时间的、激烈的斗争之后,为了测试PyPi的修订版,我尝试将该文件缩减到最低限度,然后重新构建它。结果发现第一行总是被处理的,然后其他的都不处理。。。在

解决方案

发现第一行的线索后,我顿悟。。。我只需更改文件中的行尾!我在Windows中编辑文件,Windows的行尾被隐式地加上了。我把它改成了Unix风格(噗!)PyPi完全呈现了doc!在

咆哮…

我以前遇到过这样的事情,但我认为PyPi会处理这样的跨平台问题是理所当然的。我的意思是Python的一个关键特性就是跨平台!我是第一个在Windows下工作的人吗?!我不喜欢浪费这么多时间。在

如果rstcheck捕获自述文件中的错误类型,可以尝试。如果是,请在脚本部分的pytest之后运行它。(并将其添加到您的ofc要求中)。在

更新

截至2018年9月21日,Python打包机构建议使用一个替代命令^{}。致install twine

pip install twine
twine check dist/*

注意twine requires ^{}。您仍然可以使用readme_renderer,并且您只需要在需要twine的其他特性时安装twine,如果您要发布到PyPI,这是一个好主意。在


来自官方的Python打包文档,Uploading your Project to PyPI

Tip: The reStructuredText parser used on PyPI is not Sphinx! Furthermore, to ensure safety of all users, certain kinds of URLs and directives are forbidden or stripped out (e.g., the .. raw:: directive). Before trying to upload your distribution, you should check to see if your brief / long descriptions provided in setup.py are valid. You can do this by following the instructions for the pypa/readme_renderer tool.

从这个工具的README.rst

To check your long description's locally simply install the readme_renderer library using:

^{pr2}$

相关问题 更多 >