Support for Sphinx 9

[amotl]

About

Make the package support Sphinx 9 by permitting installation of sphinx-design 0.7.0. Thank you, @chrisjsewell!

References

• Dependencies: Permit installation of Sphinx 9.x crate/crate-docs-theme#671
• Dependencies: Validate compatibility with sphinx 9 #167
• Please test with Sphinx 9 executablebooks/sphinx-design#245
• ⬆️ Add Sphinx 9 support executablebooks/sphinx-design#255

[coderabbitai]

Walkthrough

Updates project dependencies to support Sphinx 9 by loosening the sphinx-design version constraint from an exact pin to a flexible range. Also includes changelog documentation and removes minor formatting inconsistencies.

Changes

Cohort / File(s)	Summary
Dependency & Changelog Updates CHANGES.md, pyproject.toml	Modified sphinx-design dependency constraint from ==0.6.1 to >=0.6.1,<0.8 to enable Sphinx 9 compatibility; added corresponding unreleased changelog entry documenting the change
Documentation Cleanup docs/hyper.md	Removed stray separator dash and extra blank line in Shield Shortcuts section

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• Dependencies: Validate compatibility with sphinx 9 #167: Updates project metadata and CHANGES.md to enable Sphinx 9 compatibility by loosening sphinx-design dependency constraints in a similar manner.

Poem

🐰 A sphinx awaits in version nine so new,
So we loosen chains of design—let it through!
Dependencies dance in ranges so wide,
While stray dashes vanish with changelog pride. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly and clearly summarizes the main objective of the changeset: enabling Sphinx 9 support through sphinx-design dependency updates.
Description check	✅ Passed	The description is directly related to the changeset, explaining the purpose (Sphinx 9 support) and referencing the sphinx-design 0.7.0 update and related upstream changes.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch sphinx9

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.78%. Comparing base (f4a9a5d) to head (c2b2c49).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #170   +/-   ##
=======================================
  Coverage   94.78%   94.78%           
=======================================
  Files          10       10           
  Lines         594      594           
=======================================
  Hits          563      563           
  Misses         31       31           

Flag	Coverage Δ
unittests	94.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[amotl]

The RTD build run using Sphinx v9.1.0 and myst v5.0.0 is hitting two kinds of warnings, one from Python and one from Sphinx / docutils.

/home/docs/checkouts/readthedocs.org/user_builds/sphinx-design-elements/envs/170/lib/python3.14/site-packages/myst_parser/inventory.py:369:
RemovedInSphinx10Warning: The iter() interface for _InventoryItem objects is deprecated. Please access the `project_name`, `project_version`, `uri`, and `displayname` attributes directly.
  project, version, loc, text = data[target]

-- https://app.readthedocs.org/projects/sphinx-design-elements/builds/31079757/#302672396--14

/home/docs/checkouts/readthedocs.org/user_builds/sphinx-design-elements/checkouts/170/docs/hyper.md:1194:
WARNING: Transition must be child of <document> or <section>. [docutils]

-- https://app.readthedocs.org/projects/sphinx-design-elements/builds/31079757/#302672396--50

NB: I am just documenting the hiccup diligently so that others in the same or a similar boat can find related problems when updating to Sphinx 9, and hopefully find a solution right away within this PR.

[amotl]

The second warning was mitigated with 685f0ce. 🪂
The first one wasn't investigated yet, but isn't fatal right now. 🤷

[amotl]

That spot raised this Sphinx warning, effectively failing the build because we are using -W --keep-going across the board?

WARNING: Transition must be child of <document> or <section>. [docutils]