pydata_sphinx_theme.pygments#

处理 Pygments css。

灵感来自 Furo 主题 pradyunsg/furo

函数#

_get_styles(formatter, prefix)

从格式化程序中获取样式，其中所有内容都具有正确的前缀。

get_pygments_stylesheet(light_style, dark_style)

生成主题特定的 pygments.css。

overwrite_pygments_css(app[, exception])

覆盖 pygments.css 以允许动态切换明暗模式。

模块内容#

pydata_sphinx_theme.pygments._get_styles(formatter, prefix)[source]#

从格式化程序中获取样式，其中所有内容都具有正确的前缀。

参数：

  • formatter (pygments.formatters.HtmlFormatter)

  • prefix (str)

返回类型：

None

pydata_sphinx_theme.pygments.get_pygments_stylesheet(light_style, dark_style)[source]#

生成主题特定的 pygments.css。

无法告诉 Sphinx 主题如何处理模式。

参数：

  • light_style (str)

  • dark_style (str)

返回类型：

str

pydata_sphinx_theme.pygments.overwrite_pygments_css(app, exception=None)[source]#

覆盖 pygments.css 以允许动态切换明暗模式。

Sphinx 原生支持配置变量 pygments_style 和 pygments_dark_style。但是，引用 www.sphinx-doc.org/en/master/development/theming.html#creating-themes

pygments_dark_style 设置 […用于] 当 CSS 媒体查询 (prefers-color-scheme: dark) 评估为 true 时。

这不允许用户动态切换，因此在构建时，我们覆盖 pygment.css 文件，使其嵌入 2 个版本

  • 以“[data-theme=”light”]”为前缀的浅色主题

  • 以“[data-theme=”dark”]”为前缀的深色主题

如果用户请求的（或我们的主题指定的）pygments 主题不可用，则此函数中定义了回退。

参数：

app (sphinx.application.Sphinx)