代码之家 › 专栏 › 技术社区 › guettli

如何确保自述。rst有效吗?

restructuredtext travis-ci continuous-integration python

guettli · 技术社区 · 8 年前

我的小工具有两个版本:

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

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。这不是问题所在:-)

3 回复 | 直到 8 年前

adrin 6 年前

使现代化

截至2018年9月21日,Python打包管理局建议使用另一种命令 twine check . 到 install twine :

pip install twine
twine check dist/*

请注意 twine requires readme_renderer readme\u渲染器 ,并且您只需要在需要其其他功能时安装Thine,如果您要发布到PyPI,这是一个好主意。

从官方Python打包文档中, Uploading your Project to PyPI

提示: PyPI上使用的重构文本解析器是不斯芬克斯此外,为了确保所有用户的安全,禁止或删除某些类型的URL和指令(例如 .. raw:: 指令)。之前试图上传您的发行版时,您应该检查是否在 setup.py 有效。您可以按照 pypa/readme_renderer 工具

从这个工具的 README.rst :

要在本地检查详细描述,只需安装 readme\u渲染器

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

BuvinJ Felix 7 年前

序言

我有一个自述文件,除了页面上的第一个元素(图像)之外,它不会在PyPi上呈现。我针对多个验证器运行了该文件,并针对其他呈现进行了测试。它在其他任何地方都工作得很好!因此,在与它进行了一场漫长而激烈的斗争之后,为了能够测试PyPi版本,我尝试将文件缩减到最低限度,并从中重新构建。事实证明 始终处理第一行,然后不处理任何其他内容

解决方案

发现了关于第一行的线索,我顿悟了。。。我所要做的就是

怒吼

renefritze 8 年前

你可以试试如果 rstcheck

推荐文章

roman · 如何自动将图像的绝对路径添加到markdown

2 年前