`sphinx.ext.linkcode` -- 添加到源代码的外部链接¶

Module author: Pauli Virtanen

Added in version 1.2.

此扩展查看您的对象描述（.. class::、.. function:: 等）并将外部链接添加到托管在 Web 上的代码。其目的类似于 sphinx.ext.viewcode 插件，但假定源代码可以在互联网上的某个地方找到。

在您的配置中，您需要指定 linkcode_resolve 函数，根据对象返回 URL。

配置¶

linkcode_resolve¶

函数 linkcode_resolve(domain, info)，应返回与给定域中给定信息对应的对象的源代码 URL。

如果不添加链接，则函数应返回 None。

参数 domain 指定对象所在的语言域。 info 是一个字典，其中保证存在以下键（取决于域）：

py: module (模块名称), fullname (对象名称)
c: names (对象名称列表)
cpp: names (对象名称列表)
javascript: object (对象名称), fullname (项目名称)

示例：

def linkcode_resolve(domain, info):
    if domain != 'py':
        return None
    if not info['module']:
        return None
    filename = info['module'].replace('.', '/')
    return "https://somesite/sourcerepo/%s.py" % filename

sphinx.ext.linkcode -- 添加到源代码的外部链接¶

配置¶

`sphinx.ext.linkcode` -- 添加到源代码的外部链接¶