如何将图像添加到PyPi自述文件（适用于GitHub）？

Question

在我关于GitHub的自述文件中，我在项目的源代码树中有几个图像，我用

等指令成功引用了这些图像。

.. image:: ./doc/source/_static/figs/moon_probe.png

我还希望在PyPi中生成相同的自述文件时显示这些图像。

我如何（a）确保PyPi上存在图像以供自述文件访问，以及（b）制定.. image::指令以访问它们？

Answer 1

转到 Github 存储库中的图像地址。显示的路径将是这样的： https://github.com/tensorbored/kds/blob/master/docs/_static/readme_lift.png 将图像地址中的 blob 术语更改为 raw https://github.com/tensorbored/kds/raw/master/docs/_static/readme_lift.png

Answer 2

PyPI不会读取图片的包发行版。您必须使用图片的外部链接，例如：

.. image::  https://raw.githubusercontent.com/greyli/flask-share/master/images/demo.png

这里我使用Github托管的图像，真正的演示在PyPI。

P.S。要在Github上获取图像的原始链接，请左键单击该图像，然后选择 在新标签页中打开图像 。

Answer 3

如果您在Github上有图片，请导航至该图片，然后右键单击下载按钮并复制链接地址：

然后您可以将其添加到README.md文件中：

![](https://github.com/your_username/your_repository/raw/master/images/img2.png)

应该同时在Github和PyPi上正确渲染。