README.rst无法在PyPi上呈现

时间:2018-03-05 09:02:24

标签: python restructuredtext pypi

我在GitHub托管的项目中有一个README.rst。它在GitHub上呈现正常,但无法在PyPi上呈现,即我在PyPi项目描述页面上看到原始内容。

我查看了类似的问题并使用python setup.py -r和包rstcheck&来检查了第一种格式collective.checkdocs,所有这些都不会引发任何错误。没有相关链接或内部链接。我不知道这里有什么问题以及如何解决这个问题。

我知道这个问题已被多次询问过。我想我已经尝试了所有的解决方案而且它们对我不起作用,这就是为什么我要再问一次。

1 个答案:

答案 0 :(得分:5)

How to ensure that README.rst is valid?

上查看我的回答
python setup.py check -r -s
running check
warning: Check: :11: (WARNING/2) "raw" directive disabled.

warning: Check: Invalid markup which will not be rendered on PyPI.

error: Please correct your package.

要修复,请不要使用raw指令,而是使用image directive with its various attributes

.. image:: https://plot.ly/~aishpant/1.png?share_key=8mG4JmyySLLYjbjTg7Uy62
   :target: https://plot.ly/~aishpant/1/?share_key=8mG4JmyySLLYjbjTg7Uy62
   :align: center
   :alt: sysfs line plot
   :width: 600px