pydata_sphinx_theme.translator

为 Bootstrap 布局定制的 Sphinx HTML 翻译器。

属性

logger

类

BootstrapHTML5TranslatorMixin

用于 Bootstrap 化 Sphinx 布局的混合 HTML 翻译器。

函数

setup_translators(app)

如果使用 HTML 翻译器，则添加 bootstrap HTML 功能。

模块内容

class pydata_sphinx_theme.translator.BootstrapHTML5TranslatorMixin(*args, **kwds)

用于 Bootstrap 化 Sphinx 布局的混合 HTML 翻译器。

只重写了几个函数，以生成可以直接用 Bootstrap 进行样式设置的有效 HTML，并符合无障碍最佳实践。

depart_table(node)

自定义 depart_table 方法，用于关闭我们在 visit_table 中添加的滚动 div。

starttag(*args, **kwargs)

对标签进行少量修改。

• 确保为任何具有标题角色的标签设置 aria-level

visit_table(node)

自定义 visit table 方法。

复制 sphinx 源代码，不添加“docutils”和“align-default”类，但添加“table”类。

table_style = 'table'

pydata_sphinx_theme.translator.setup_translators(app)

如果使用 HTML 翻译器，则添加 bootstrap HTML 功能。

这重新使用了现有的 Sphinx 翻译器，并添加了在 BootstrapHTML5TranslatorMixin 中定义的额外功能。这样，我们就可以保留原始翻译器的行为和配置，并_只_添加额外的 bootstrap 规则。如果我们没有检测到基于 HTML 的翻译器，那么我们什么也不做。

参数：:

app (sphinx.application.Sphinx)

pydata_sphinx_theme.translator.logger