Skip to content
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.

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

adapt to sphinx 8 release #1938

Closed
drammock opened this issue Jul 24, 2024 · 7 comments · May be fixed by #1971
Closed

adapt to sphinx 8 release #1938

drammock opened this issue Jul 24, 2024 · 7 comments · May be fixed by #1971
Labels
kind: maintenance Improving maintainability and reducing technical debt needs: investigation Someone in the team needs to investigate and try and reproduce this issue
Milestone

Comments

@drammock
Copy link
Collaborator

Sphinx8.0.0rc1 is out: sphinx-doc/sphinx#12629

we should

  1. make sure everything still works, and
  2. check our pins and see if we can/should drop support for any earlier versions soon
@drammock drammock added kind: maintenance Improving maintainability and reducing technical debt needs: investigation Someone in the team needs to investigate and try and reproduce this issue labels Jul 24, 2024
@trallard
Copy link
Collaborator

You beat me to this. I saw the release plan and thought about adding this to CI.

@Carreau Carreau added the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Aug 7, 2024
@Carreau
Copy link
Collaborator

Carreau commented Aug 7, 2024

I'm marking as relase blocker, I think if we do a new release it should be compatible with sphinx 8.

@trallard
Copy link
Collaborator

It seems all is good for a new release, so I will remove the release blocker label and make a pre-release. BUT will not close this issue until we have verified no hiccups and we cut a proper release.

@trallard trallard removed the impact: block-release Should block a release from happening. Only use if this is a critical problem we don't want to ship label Sep 30, 2024
@gabalafou
Copy link
Collaborator

Has anyone else gotten the "misc.copy_overwrite" warning that Sphinx 8 introduced? I get it whenever I try to build the docs locally. Unfortunately I cannot add the warning to warnings_list.txt because the string includes a local file path and our check_warnings.py script only does exact string matching, and I'm not sure if we want to change that.

In the meantime, I add the following line in my local dev to conf.py:

suppress_warnings = ["misc.copy_overwrite"]

Is that a line we want to commit?

I filed a bug on the nbsphinx repo:

@trallard
Copy link
Collaborator

I just rebuilt our docs with tox and could not reproduce this issue.
@gabalafou are you still seeing this behaviour?

@trallard
Copy link
Collaborator

I am closing this issue as it all seems ok with the latest release but we can check back if any issues arise

@gabalafou
Copy link
Collaborator

I just rebuilt our docs with tox and could not reproduce this issue. @gabalafou are you still seeing this behaviour?

Yes, still seeing the behavior with latest main. It doesn't happen on the first build, only on the second:

tox run -e docs-dev
tox run -e docs-dev ⬅️ misc.copy_overwrite happens here

It doesn't seem to be a major issue though. As far as I can tell, it just prevents the .ipynb file from being updated in the build directory if you made changes to the corresponding .ipynb file in the source directory. But I guess this only affects local dev since I'm guessing that CI builds into a fresh directory.

I opened an issue (and pull request) on nbsphinx:

@Carreau Carreau added this to the 0.16.1 milestone Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: maintenance Improving maintainability and reducing technical debt needs: investigation Someone in the team needs to investigate and try and reproduce this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants