pydata_sphinx_theme#

来自 PyData 社区的基于 Bootstrap 的 Sphinx 主题。

子模块#

属性#

函数#

_fix_canonical_url(app, pagename, templatename, ...)

使用 dirhtml 构建器时修复规范 URL。

setup(app)

设置 Sphinx 应用程序。

update_and_remove_templates(app, pagename, ...)

更新模板名称和页面构建的资产。

update_config(app)

使用新的默认值更新配置并处理已弃用的键。

包内容#

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

使用 dirhtml 构建器时修复规范 URL。

如果设置了 html_baseurl 配置,Sphinx 会构建一个规范 URL。但是,它在使用 dirhtml 构建器时构建一个以“.html”结尾的 URL,这是不正确的。检测到这种情况并为每个页面生成正确的 URL。

针对 sphinx-doc/sphinx#9730 的解决方法;可以在修复、发布并在我们支持的最小 Sphinx 版本中可用后删除。

参数::
返回类型::

None

pydata_sphinx_theme.setup(app)[source]#

设置 Sphinx 应用程序。

参数::

app (sphinx.application.Sphinx)

返回类型::

Dict[str, str]

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

更新模板名称和页面构建的资产。

参数::
返回类型::

None

pydata_sphinx_theme.update_config(app)[source]#

使用新的默认值更新配置并处理已弃用的键。

pydata_sphinx_theme.__version__ = '0.16.0'[source]#