Upgrade to bootstrap 5#
pydata-sphinx-theme has moved from Bootstrap 4 to Bootstrap 5.
This documentation will guide you through the changes we made and how you could follow the same steps in your existing documentation.
Sphinx v6 will do the same (sphinx-doc/sphinx#10070).
Any documentation relying on JQuery in their
custom.js files will need to rewrite or specifically import JQuery.
Relevant for those using a
custom.css and/or a
Bootstrap changed several CSS classes, so if you wrote custom rules of JS logic that depended on them, it may have changed.
All the changes from v4 to v5 are listed in their documentation.
Below list the ones that had consequences on
Media query mixins parameters have changed for a more logical approach.
media-breakpoint-down()uses the breakpoint itself instead of the next breakpoint (e.g.,
media-breakpoint-down(md)targets viewports smaller than lg).
Similarly, the second parameter in
media-breakpoint-between()also uses the breakpoint itself instead of the next breakpoint (e.g.,
media-between(sm, lg)instead of
media-breakpoint-between(sm, md)targets viewports between sm and lg).
box-shadowmixins now allow
nullvalues and drop
nonefrom multiple arguments.
Content, Reboot, etc#
Nested tables do not inherit styles anymore.
.thead-darkare dropped in favor of the
.table-*variant classes which can be used for all table elements (
.text-justifyclass. See twbs/bootstrap#29793
Renamed several utilities to use logical property names instead of directional names with the addition of RTL support: