升级到 Bootstrap 5#
从 v0.13 开始,pydata-sphinx-theme
已从 Bootstrap 4 迁移到 Bootstrap 5。本文档将指导您完成我们所做的更改,以及如何在现有文档中遵循相同的步骤。
放弃 JQuery#
Bootstrap 放弃了 JQuery 依赖关系,并重写了插件使其成为普通 JavaScript。Sphinx v6 将执行相同的操作 (sphinx-doc/sphinx#10070)。因此,我们也重写了所有 JavaScript 代码,使其仅使用原生 JavaScript。任何在 custom.js
文件中依赖于 JQuery 的文档都需要重写或专门导入 JQuery。
重大更改#
重要
适用于那些使用 custom.css
和/或 custom.js
文件的人!
Bootstrap 更改了多个 CSS 类,因此如果您编写了依赖于它们的自定义规则或 JS 逻辑,它们可能已经改变。
从 v4 到 v5 的所有更改都列在其文档中。以下列出对 pydata-sphinx-theme
组件有影响的那些更改。
Sass#
媒体查询混合参数已更改为更符合逻辑的方法。
media-breakpoint-down()
使用断点本身,而不是下一个断点(例如,media-breakpoint-down(lg)
而不是media-breakpoint-down(md)
目标为小于 lg 的视口)。类似地,
media-breakpoint-between()
中的第二个参数也使用断点本身,而不是下一个断点(例如,media-between(sm, lg)
而不是media-breakpoint-between(sm, md)
目标为 sm 和 lg 之间的视口)。
box-shadow
混合现在允许null
值,并从多个参数中删除none
。
内容、重启等#
嵌套表格不再继承样式。
.thead-light
和.thead-dark
被删除,取而代之的是.table-*
变体类,可用于所有表格元素 (thead
、tbody
、tfoot
、tr
、th
和td
)。删除了
.text-justify
类。请参阅 twbs/bootstrap#29793
实用程序#
重命名了多个实用程序,以使用逻辑属性名称代替方向名称,并添加了 RTL 支持
重命名
.left-*
和.right-*
为.start-*
和.end-*
。重命名
.float-left
和.float-right
为.float-start
和.float-end
。重命名
.border-left
和.border-right
为.border-start
和.border-end
。重命名
.rounded-left
和.rounded-right
为.rounded-start
和.rounded-end
。重命名
.ml-*
和.mr-*
为.ms-*
和.me-*
。重命名
.pl-*
和.pr-*
为.ps-*
和.pe-*
。重命名
.text-left
和.text-right
为.text-start
和.text-end
。