您如何 link 将您的文档文件夹中的图像放入 README.rst?

How do you link to images from your docs folder in your README.rst?

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

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

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

在 github (https://github.com/thebjorn/pydeps), but show up as broken links on PyPI (https://pypi.org/project/pydeps/1.6.0/) 上看起来很棒。

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

您需要使用 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. 正确替换了 URL(同时删除了路径中的 blob 部分 - 我的错!),
  2. ?sanitize=true 附加到每个 URL 被替换。

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

正在测试 on Github and on TestPyPI,看起来都不错。


备选方案:使用 RawGit

另一种可能性是使用 RawGit,尽管缺点是这是第三方服务,因此当它关闭时,图像不会呈现,尽管可用。尽管如此,为了完整起见:

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