如何将图像添加到 Python 包索引文档中？

Posted 2023-02-24

【中文标题】如何将图像添加到 Python 包索引文档中？

【英文标题】：How can images be added to Python Package Index documentation?

【发布时间】：2016-05-04 12:05:27

【问题描述】：

我有一个模块存储库，其中包含模块代码、README.md 文件和存储在目录images/ 中的 README.md 文件中使用的图像（使用相对链接链接到 README.md 中）。为了注册模块并将其上传到 PyPI，我有文件 setup.py 和 MANIFEST.in。应该如何使图像包含并出现在 PyPI 在线文档中（如在假设页面 https://pypi.python.org/pypi/junkmodule 中出现的那样）？

我目前拥有的MANIFEST.in和setup.py（并且不包括PyPI在线文档中的图像）如下：

MANIFEST.in

include LICENSE
include README.md
include images/*
include setup.py
include junkmodule.py

setup.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

import os
import setuptools

def main():

    setuptools.setup(
        name             = "junkmodule",
        version          = "0.0.0.1",
        description      = "provides nothing much",
        long_description = Markdown_to_reStructuredText("README.md"),
        url              = "https://github.com/junkuser1/junkmodule",
        author           = "L. Ron. Hubbard",
        author_email     = "[e-mail]",
        license          = "GPLv3",
        py_modules       = ["junkmodule"],
        entry_points     = """
            [console_scripts]
            junkmodule = junkmodule:junkmodule
        """
    )

def read(*paths):
    with open(os.path.join(*paths), "r") as filename:
        return filename.read()

def Markdown_to_reStructuredText(filename):
    try:
        import pypandoc
        return pypandoc.convert(filename, "rst")
    except:
        print("pypandoc not found; long description could be corrupted")
        return read(filename)

if __name__ == "__main__":
    main()

【参考方案1】：

possible solution 将图像托管在 GitHub 上，然后在 README 中包含图像及其明确的 URL。

以README为例：该标志包含在

![](https://raw.githubusercontent.com/mwouts/jupytext/master/docs/logo.png)

并且徽标确实出现在pip。

请注意，您甚至不需要将图像托管在同一个 GitHub 存储库中 - 您只需要一个有效的 URL（另一个存储库中的图像，或者 gits 也可以）。

【讨论】：

欢迎来到 Stack Overflow！虽然链接是分享知识的好方法，但如果它们在未来被破坏，它们将无法真正回答问题。将回答问题的链接的基本内容添加到您的答案中。如果内容太复杂或太大而无法在此处放置，请描述所提出解决方案的总体思路。请记住始终保留对原始解决方案网站的链接引用。见：How do I write a good answer?

我在您的“此结果”页面上看到一个空的“屏幕截图”标题，但我没有看到任何图像。您所指的显示图像在哪里？

啊...我在您的 .md 文件中看到了图像参考，但该图像在 githubusercontent.com 上不再可用