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 or None) – 文档的链接 (URL)。

• type_ (str) – 类型。仅在 return_type 为 True 时返回。