Support Sphinx>=9

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python

Research direction

Start by inspecting the dependency constraint in pyproject.toml and the documentation setup using the sphinx.ext.coverage extension. Remove the restriction that prevents Sphinx 9, then verify that the guppy documentation builds and that the coverage extension works with Sphinx 9.

Written by the indexing model from the issue text.

Description

Currently we specify furo = "^2024.5.6" in pyproject.toml which is effectively "<2025.*.*" which in turn forces Sphinx<9. This should be removable I think. It would allow us to pick up newer features and fixes. Including a fix to the sphinx.ext.coverage extension which would improve the guppy docs.

Dominant language
CSS
Stars
3
Forks
2
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Quantinuum/quantinuum-sphinx

All issues in Quantinuum/quantinuum-sphinx

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.