sphinx.ext.linkcode --ソースコードへの外部リンクの追加

モジュールの作者: Pauli Virtanen

バージョン 1.2 で追加.

This extension looks at your object descriptions (.. class::, .. function:: etc.) and adds external links to code hosted somewhere on the web. The intent is similar to the sphinx.ext.viewcode extension, but assumes the source code can be found somewhere on the Internet.

あなたの構成では、指定する必要があります 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