PyData 包支持#

该主题由 PyData 社区为其设计,因此我们在某些地方为该社区的包提供特殊支持。

我们定义了 CSS 规则,以确保 Sphinx 中的 PyData 内容在浅色和深色主题下看起来都合理。如果我们收到维护人员的报告,称我们可以更改主题中的某些内容,使他们的文档看起来更好,并且如果此更改对我们来说是可持续的,那么我们应该进行更改。

我们将 PyData 特定的 SCSS 存储在两个相关文件中,这两个文件都在 src/pydata_sphinx_theme/assets/styles/ 文件夹中

  • extensions/_execution.scss - 用于执行并将代码插入文档的 Sphinx 库的样式。例如,MyST-NB、Jupyter Sphinx 和 Matplotlib plot 指令。大多数 PyData 支持应该通过所有包都能从中受益的通用改进来实现。

  • extensions/_pydata.scss - PyData 生态系统中特定库的样式。一般来说,我们应该尽量保持这种样式的简洁,因为它主要是针对单个库的特殊情况。