pydata_sphinx_theme.toctree#

用于构建 html 页面中使用的 toctree 的方法。

类#

LinkInfo

用于生成 toctree 数据的数据类。

函数#

_get_ancestor_pagename(app, pagename, startdepth)

获取pagename的祖先的名称，该祖先位于全局根目录下startdepth级。

add_collapse_checkboxes(soup)

在 toctree 中添加复选框以折叠子项。

add_inline_math(node)

使用激活 MathJax 处理的 HTML 标签呈现节点。

add_toctree_functions(app, pagename, templatename, ...)

添加函数，以便 Jinja 模板可以添加 toctree 对象。

get_nonroot_toctree(app, pagename, ancestorname, ...)

获取支配pagename的局部 TocTree（根目录位于ancestorname）。

模块内容#

class pydata_sphinx_theme.toctree.LinkInfo[source]#

用于生成 toctree 数据的数据类。

href: str[source]#
is_current: bool[source]#
is_external: bool[source]#
title: str[source]#
pydata_sphinx_theme.toctree._get_ancestor_pagename(app, pagename, startdepth)[source]#

获取pagename的祖先的名称，该祖先位于全局根目录下startdepth级。

参数:
返回类型:

str

pydata_sphinx_theme.toctree.add_collapse_checkboxes(soup)[source]#

在 toctree 中添加复选框以折叠子项。

参数:

soup (bs4.BeautifulSoup)

返回类型:

无

pydata_sphinx_theme.toctree.add_inline_math(node)[source]#

使用激活 MathJax 处理的 HTML 标签呈现节点。

这旨在用于渲染包含数学公式的节标题，因为数学输出被 pydata-sphinx-theme 的标题忽略。

与来自：sphinx-doc/sphinx的普通数学节点的行为相关

参数:

node (docutils.nodes.Node)

返回类型:

str

pydata_sphinx_theme.toctree.add_toctree_functions(app, pagename, templatename, context, doctree)[source]#

添加函数，以便 Jinja 模板可以添加 toctree 对象。

参数:
返回类型:

无

pydata_sphinx_theme.toctree.get_nonroot_toctree(app, pagename, ancestorname, toctree, **kwargs)[source]#

获取支配pagename的局部 TocTree（根目录位于ancestorname）。

参数：app : Sphinx 应用程序。pagename : 当前页面的名称（如 Sphinx 所知；即它相对于文档根目录的相对路径）。ancestorname : 支配pagename的页面的名称，它将用作 TocTree 片段的根目录。toctree : Sphinx TocTree 对象。由于在查找 ancestorname 时始终需要它（见 _get_ancestor_pagename），因此将它传递到这里以重复使用它。kwargs : 传递给 Sphinx toctree 模板函数。

这类似于context[“toctree”](**kwargs)（在 Jinja 模板中称为toctree(**kwargs)），或者TocTree.get_toctree_for()，它始终使用“根”doctree（即doctree = self.env.get_doctree(self.env.config.root_doc)）。

参数: