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

问题描述 投票:0回答:2

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

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

我想添加一个超链接到“这里”以指向一个网站。如果不安装外部插件,我该怎么做?

python api hyperlink documentation docstring
2个回答
3
投票

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

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

doctring 只是一个字符串,所以没有超链接。但是任何想看网站的人都可以复制链接。

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


0
投票

如果您使用 sphinx 生成文档

""" 

`here <url>`__

"""

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

© www.soinside.com 2019 - 2024. All rights reserved.