sphinx_gallery.docs_resolv#

リンク解決オブジェクト。

関数#

ドキュメントへのハイパーリンクをサンプルコードに埋め込みます。

クラス#

class sphinx_gallery.docs_resolv.SphinxDocLinkResolver(config, doc_url, gallery_dir, relative=False)[ソース]#

Sphinxによって生成されたsearchindex.jsを使用して、ドキュメントへのリンクを解決します。

パラメータ：

  • doc_url (str) – プロジェクトウェブサイトのベースURL。

  • relative (bool) – 相対リンクを返す（このパッケージのドキュメントへのリンクにのみ有用）。

resolve(cobj, this_url, return_type=False)[ソース]#

ドキュメントへのリンクを解決し、見つからない場合はNoneを返します。

パラメータ：

  • cobj (Dict[str, Any]) –

    リンクを解決している「コードオブジェクト」に関する情報を格納した辞書。

    • cobj[‘name’] : 関数またはクラス名 (str)

    • cobj[‘module’] : モジュール名 (str)

    • cobj[‘module_short’] : 短縮されたモジュール名 (str)

    • cobj[‘is_class’] : オブジェクトがクラスかどうか (bool)

    • cobj[‘is_explicit’] : オブジェクトが明示的な逆参照（sphinxマークアップで参照）かどうか (bool)

  • this_url (str) – 現在のページのURL。相対URLの作成に必要なもの（コンストラクタでrelative=Trueの場合にのみ使用）。

  • return_type (bool) – Trueの場合、型も返します。

戻り値：

  • link (str または None) – ドキュメントへのリンク（URL）。

  • type_ (str) – 型。return_typeがTrueの場合にのみ返されます。

このページの内容