pydata_sphinx_theme.logo#
自定义用于徽标管理的事件。
我们使用一个事件将自定义徽标图像复制到 _static,另一个事件将它们链接到 html 上下文
函数#
|
将徽标图像复制到 _static 目录。 |
|
在我们的 HTML 模板中设置徽标的相对路径。 |
模块内容#
- pydata_sphinx_theme.logo.copy_logo_images(app, exception=None)[source]#
将徽标图像复制到 _static 目录。
如果给出了徽标图像路径,则将其复制到 _static 文件夹中,然后我们可以在 html_page_context 事件中直接链接到它们。
- 参数:
- 返回类型:
None
- pydata_sphinx_theme.logo.setup_logo_path(app, pagename, templatename, context, doctree)[source]#
在我们的 HTML 模板中设置徽标的相对路径。
在 Sphinx 中,context[“logo”] 是指向现在位于输出 _static 文件夹中的 html_logo 图像的路径。
如果给出了 logo[“image_light”] 和 logo[“image_dark”],我们必须修改它们以遵循相同的模式。它们已经在 update_config 事件中被复制到输出文件夹中。
- 参数:
pagename (str)
templatename (str)
context (dict)
doctree (docutils.nodes.Node)
- 返回类型:
None