sphinx_gallery.docs_resolv

連結解析器物件。

函數

sphinx_gallery.docs_resolv.embed_code_links(app, exception)

將超連結嵌入到範例程式碼中，指向文件。

sphinx_gallery.docs_resolv.get_data(url, gallery_dir)

使用持久化字典來檢索搜尋索引。

sphinx_gallery.docs_resolv.parse_sphinx_docopts(index)

解析 Sphinx 索引以取得文件選項。

參數:

index (str) – Sphinx 索引頁面

返回:

docopts – 頁面中的文件選項。

返回類型:

dict

類別

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 時返回。