Skip to content

build(deps): update sphinx-design requirement from >=0.7.0 to >=0.8.0 - #130

Merged
edkerk merged 2 commits into
mainfrom
dependabot/pip/sphinx-design-gte-0.8.0
Nov 18, 2026
Merged

edkerk merged 2 commits into
mainfrom
dependabot/pip/sphinx-design-gte-0.8.0

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Nov 18, 2026

Copy link
Copy Markdown
Contributor

Updates the requirements on sphinx-design to permit the latest version.

Release notes

Sourced from sphinx-design's releases.

v0.8.0

New components (accordion, aside, steps, vertical tab sets, and explicit card header and footer directives), links that open in a new tab, badge tooltips, a plain-CSS build with no Sass, tab selections that persist across pages and visits, accessibility fixes, FontAwesome v6 support, and Octicons v19.42.0. Sphinx 7.2 or later is now required.

Upgrade notes

  • Sphinx >=7.2 is required (Sphinx 7.0 and 7.1 are no longer supported); Python stays at >=3.11 ({pr}276).

  • The ^^^ and +++ card separators are deprecated and warn by default. They still render as before, but the first card in a document that uses them emits one design.card_legacy warning, so a build run with -W fails until you do one of two things:

    • move the header and footer into the new card-header and card-footer directives (or the one-line :header: and :footer: options), which need sphinx-design 0.8.0 or later; or
    • add "design.card_legacy" to suppress_warnings in your conf.py.

    Once every card is migrated, set sd_card_legacy_separators = False to stop scanning for the separators. The plan is to turn the separators off by default in 1.0 and remove them in 2.0; the cards page has a migration table ({pr}294).

  • Tab selections persist in localStorage instead of sessionStorage, so a chosen tab is remembered across browsing sessions as well as across pages. The storage key prefix is set by the new sd_tabs_storage_prefix option; set it to an empty string to disable persistence ({pr}284, {issue}103).

  • Static assets are served through Sphinx's html_static_path, only for HTML-format builders. A _sphinx_design_static directory left in an existing build directory by an earlier version is unused and can be deleted ({pr}276).

  • The stylesheet is plain CSS, generated without Sass. The --sd-color-*-highlight hover and focus shades are now derived at runtime with color-mix() (behind the old value as a static fallback), so overriding a --sd-color-* variable now also changes its hover shade ({pr}290).

  • The private sphinx_design._compat.findall helper is removed; call node.findall(...) directly ({pr}276). The private CardDirective._create_component method is renamed _create_slot; the old name stays as an alias for one release ({pr}294).

  • sd-card-text is added only to the direct child paragraphs of a card or dropdown body, and is added to a paragraph's classes instead of replacing them; paragraphs nested deeper (in admonitions, lists, nested tab sets) no longer get it ({pr}278).

New

  • ✨ accordion directive: groups dropdowns so that opening one closes the others, using the browser's native <details name> behaviour with no JavaScript; :flush: renders it edge to edge by {user}chrisjsewell in {pr}291
  • ✨ aside directive: a call-out box floated beside the body text (:align:, :width:), rendered as a semantic <aside> in HTML and a plain titled container elsewhere by {user}chrisjsewell in {pr}292 ({issue}97)
  • ✨ steps and step directives for numbered procedures, with CSS-only number markers on an ordered list, :start: and :color: options by {user}chrisjsewell in {pr}293
  • ✨ card-header and card-footer directives, and :header: and :footer: options, for card and grid-item-card headers and footers: the card body is parsed once as ordinary content, and errors in a header or footer report their own line (see the upgrade notes for the legacy separators) by {user}chrisjsewell in {pr}294

... (truncated)

Changelog

Sourced from sphinx-design's changelog.

0.8.0 - 2026-11-10

New components (accordion, aside, steps, vertical tab sets, and explicit card header and footer directives), links that open in a new tab, badge tooltips, a plain-CSS build with no Sass, tab selections that persist across pages and visits, accessibility fixes, FontAwesome v6 support, and Octicons v19.42.0. Sphinx 7.2 or later is now required.

Upgrade notes

  • Sphinx >=7.2 is required (Sphinx 7.0 and 7.1 are no longer supported); Python stays at >=3.11 ({pr}276).

  • The ^^^ and +++ card separators are deprecated and warn by default. They still render as before, but the first card in a document that uses them emits one design.card_legacy warning, so a build run with -W fails until you do one of two things:

    • move the header and footer into the new card-header and card-footer directives (or the one-line :header: and :footer: options), which need sphinx-design 0.8.0 or later; or
    • add "design.card_legacy" to suppress_warnings in your conf.py.

    Once every card is migrated, set sd_card_legacy_separators = False to stop scanning for the separators. The plan is to turn the separators off by default in 1.0 and remove them in 2.0; the cards page has a migration table ({pr}294).

  • Tab selections persist in localStorage instead of sessionStorage, so a chosen tab is remembered across browsing sessions as well as across pages. The storage key prefix is set by the new sd_tabs_storage_prefix option; set it to an empty string to disable persistence ({pr}284, {issue}103).

  • Static assets are served through Sphinx's html_static_path, only for HTML-format builders. A _sphinx_design_static directory left in an existing build directory by an earlier version is unused and can be deleted ({pr}276).

  • The stylesheet is plain CSS, generated without Sass. The --sd-color-*-highlight hover and focus shades are now derived at runtime with color-mix() (behind the old value as a static fallback), so overriding a --sd-color-* variable now also changes its hover shade ({pr}290).

  • The private sphinx_design._compat.findall helper is removed; call node.findall(...) directly ({pr}276). The private CardDirective._create_component method is renamed _create_slot; the old name stays as an alias for one release ({pr}294).

  • sd-card-text is added only to the direct child paragraphs of a card or dropdown body, and is added to a paragraph's classes instead of replacing them; paragraphs nested deeper (in admonitions, lists, nested tab sets) no longer get it ({pr}278).

New

  • ✨ accordion directive: groups dropdowns so that opening one closes the others, using the browser's native <details name> behaviour with no JavaScript; :flush: renders it edge to edge by {user}chrisjsewell in {pr}291
  • ✨ aside directive: a call-out box floated beside the body text (:align:, :width:), rendered as a semantic <aside> in HTML and a plain titled container elsewhere by {user}chrisjsewell in {pr}292 ({issue}97)
  • ✨ steps and step directives for numbered procedures, with CSS-only number markers on an ordered list, :start: and :color: options by {user}chrisjsewell in {pr}293
  • ✨ card-header and card-footer directives, and :header: and :footer: options, for card and grid-item-card headers and footers: the card body is parsed once as ordinary content, and errors in a header or footer report their own line (see the upgrade notes for the legacy separators)

... (truncated)

Commits
  • fcaa5b3 🚀 RELEASE: v0.8.0 (#317)
  • cb9828f 🔧 Drop sd_custom_roles before 0.8.0: the badge roles take a tooltip role opti...
  • c7b2d2f ⬆️ UPGRADE: Octicons to v19.42.0 (#309)
  • 6c5a4be ✨ NEW: open card and button links in a new tab (#298)
  • f2accd9 ♻️ Card header/footer sub-directives: a pure parse replaces raw-text splittin...
  • 2f473aa ✨ Add sd_custom_roles: config-defined badge roles with baked tooltips (#295)
  • 0511463 ✨ Add a steps component (#293)
  • 7d1aeed ⬆️ Bump actions/setup-python to v7 and actions/upload-artifact to v7 (#299)
  • 4c3864d ✨ Add an aside component (#292)
  • 21af548 ⬆️ Allow pydata-sphinx-theme <0.25 (#313)
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [sphinx-design](https://github.com/executablebooks/sphinx-design) to permit the latest version.
- [Release notes](https://github.com/executablebooks/sphinx-design/releases)
- [Changelog](https://github.com/executablebooks/sphinx-design/blob/main/CHANGELOG.md)
- [Commits](executablebooks/sphinx-design@v0.7.0...v0.8.0)

---
updated-dependencies:
- dependency-name: sphinx-design
  dependency-version: 0.8.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot requested a review from edkerk as a code owner November 18, 2026 05:19
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Nov 18, 2026
@edkerk
edkerk merged commit 1a17dde into main Nov 18, 2026
3 checks passed
@edkerk
edkerk deleted the dependabot/pip/sphinx-design-gte-0.8.0 branch November 18, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant