如何链接到README.rst中docs文件夹中的图像?

时间:2018-08-11 21:31:01

标签: python github restructuredtext pypi

我正在努力寻找一种在README.rst中使用图像的方法,该方法将同时显示在github和PyPI上。

当前我正在使用以下标记:

.. image:: https://github.com/thebjorn/pydeps/blob/master/docs/_static/pydeps.svg

在github(https://github.com/thebjorn/pydeps)上看起来不错,但是在PyPI(https://pypi.org/project/pydeps/1.6.0/)上显示为断开的链接。

这是可能的,还是我需要将这些图像托管在其他地方?

1 个答案:

答案 0 :(得分:3)

您需要使用raw.githubusercontent.com而不是github.com

.. image:: https://github.com/thebjorn/pydeps/blob/master/docs/_static/pydeps-pylib.svg

只能在Github本身上正确渲染,而

.. image:: https://raw.githubusercontent.com/thebjorn/pydeps/master/docs/_static/pydeps-pylib.svg?sanitize=true

将在任何网站上呈现。


首次尝试(损坏并删除)


第二次尝试:

  1. 正确替换网址(也删除了路径中的blob部分-我的错!)
  2. 在每个要替换的URL上附加?sanitize=true

$ sed -i '' 's,.. image:: https://github.com/\(.*\)/blob/\(.*\).svg,.. image:: https://raw.githubusercontent.com/\1/\2.svg?sanitize=true,g' README.rst

on Githubon TestPyPI的测试都不错。


替代:使用RawGit

另一种可能性是使用RawGit,尽管缺点是这是第三方服务,所以当它关闭时,尽管可用,但不会渲染图像。尽管如此,出于完整性考虑:

$ sed -i '' 's,.. image:: https://github.com/\(.*\)/blob/\(.*\)$,.. image:: https://cdn.rawgit.com/\1/\2,g' README.rst