如何在 Python 文档字符串中添加链接？

Question

我在 python 3.x 中有一个函数

def foo():
"""Lorem ipsum for more info, see here""

我想添加一个指向“此处”的超链接以指向网站。在不安装外部插件的情况下如何做到这一点？

Answer 1

如果您使用 sphinx 生成文档

""" 

`here <url>`__

"""

你的文档字符串中的内容应该被正确解析。

Answer 2

只需将链接作为字符串添加到文档字符串中，如下所示：

def foo():
    """Lorem ipsum for more info, see here: www.myfancydocu.com""

文档字符串只是一个字符串，因此没有超链接。但任何想要查看该网站的人都可以复制链接。

有一些自动文档生成器可以根据您的代码和文档字符串（例如 html）构建文档。这些可能可以使用特定语法向文档添加超链接，但该语法取决于您使用的文档生成器。如果您只有代码，那么只需将 url 添加为字符串即可。