Skip to content

Main branch is failing sphinx #1513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
yaelbh opened this issue Feb 23, 2025 · 4 comments · Fixed by #1514
Closed

Main branch is failing sphinx #1513

yaelbh opened this issue Feb 23, 2025 · 4 comments · Fixed by #1514
Assignees
@wshanks @yaelbh @nkanazawa1989

Comments

@yaelbh
Copy link
Collaborator

yaelbh commented Feb 23, 2025

@gadial says:
This is probably an incompatibility issue with newer sphinx versions. I think the most simple things to try are

  1. Mimic how sphinx is used in an up-to-date project like qiskit-sdk
  2. Avoid this and simply limit the sphinx versions in requirement-dev.txt such that they correspond to what worked the last time a PR was merged
@dcmckayibm
Copy link
Collaborator

Probably need to look what changed in the 0.8.2 release https://www.sphinx-doc.org/en/master/changes/index.html#release-8-2-1-released-feb-21-2025

@dcmckayibm
Copy link
Collaborator

Added Will+Naoki to get thoughts

wshanks added a commit to wshanks/qiskit-experiments that referenced this issue Feb 24, 2025
@wshanks
Pin Sphinx to <8.2 temporarily to avoid nbsphinx problem
321b39f 
The currently latest release of nbsphinx (0.9.6) is not compatible with
Sphinx 8.2.0, so here Sphinx is pinned to `<8.2`. See:

spatialaudio/nbsphinx#825

The issue is that nbsphinx does `import sphinx` and relies `sphinx` to
import all of its submodules which it no longer does.

Note -- qiskit-experiments mainly uses `jupyter-sphinx` now but it still
uses the `nbgallery` directive for the landing pages for the tutorials,
so it can not simply be dropped as a dependency (maybe the gallery could
be formatted without it).

Closes qiskit-community#1513
@wshanks wshanks mentioned this issue Feb 24, 2025
Merged
@wshanks
Copy link
Collaborator

wshanks commented Feb 24, 2025

I opened #1514 for this (just to pin Sphinx <8.2 until a version of nbsphinx compatible with Sphinx 8.2 is released).

github-merge-queue bot pushed a commit that referenced this issue Feb 24, 2025
@wshanks
Pin Sphinx to <8.2 temporarily to avoid nbsphinx problem (#1514)
28d8b35 
The currently latest release of nbsphinx (0.9.6) is not compatible with
Sphinx 8.2.0, so here Sphinx is pinned to `<8.2`. See:

spatialaudio/nbsphinx#825

The issue is that nbsphinx does `import sphinx` and relies `sphinx` to
import all of its submodules which it no longer does.

Note -- qiskit-experiments mainly uses `jupyter-sphinx` now but it still
uses the `nbgallery` directive for the landing pages for the tutorials,
so it can not simply be dropped as a dependency (maybe the gallery could
be formatted without it).

Closes
#1513
@yaelbh
Copy link
Collaborator Author

yaelbh commented Feb 25, 2025

Thanks @wshanks !!

mergify bot pushed a commit that referenced this issue Feb 25, 2025
@wshanks @mergify
Pin Sphinx to <8.2 temporarily to avoid nbsphinx problem (#1514)
a988580 
The currently latest release of nbsphinx (0.9.6) is not compatible with
Sphinx 8.2.0, so here Sphinx is pinned to `<8.2`. See:

spatialaudio/nbsphinx#825

The issue is that nbsphinx does `import sphinx` and relies `sphinx` to
import all of its submodules which it no longer does.

Note -- qiskit-experiments mainly uses `jupyter-sphinx` now but it still
uses the `nbgallery` directive for the landing pages for the tutorials,
so it can not simply be dropped as a dependency (maybe the gallery could
be formatted without it).

Closes
#1513

(cherry picked from commit 28d8b35)
@mergify mergify bot mentioned this issue Feb 25, 2025
Merged
wshanks added a commit that referenced this issue Feb 25, 2025
@mergify @wshanks
Pin Sphinx to <8.2 temporarily to avoid nbsphinx problem (backport #1514
d5083c5 
) (#1518)

The currently latest release of nbsphinx (0.9.6) is not compatible with
Sphinx 8.2.0, so here Sphinx is pinned to `<8.2`. See:

spatialaudio/nbsphinx#825

The issue is that nbsphinx does `import sphinx` and relies `sphinx` to
import all of its submodules which it no longer does.

Note -- qiskit-experiments mainly uses `jupyter-sphinx` now but it still
uses the `nbgallery` directive for the landing pages for the tutorials,
so it can not simply be dropped as a dependency (maybe the gallery could
be formatted without it).

Closes
#1513
<hr>This is an automatic backport of pull request #1514 done by
[Mergify](https://mergify.com).

Co-authored-by: Will Shanks <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wshanks wshanks

@yaelbh yaelbh

@nkanazawa1989 nkanazawa1989

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Pin Sphinx to <8.2 temporarily to avoid nbsphinx problem wshanks/qiskit-experiments
4 participants
@wshanks @yaelbh @dcmckayibm @nkanazawa1989