search

pydata / pydata-sphinx-theme

A clean, three-column Sphinx theme with Bootstrap for the PyData community
https://pydata-sphinx-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
618 stars 321 forks source link

adapt to sphinx 8 release #1938

Closed drammock closed 3 weeks ago

drammock commented 3 months ago

Sphinx8.0.0rc1 is out: https://github.com/sphinx-doc/sphinx/issues/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
trallard commented 3 months ago

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

Carreau commented 3 months ago

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

trallard commented 1 month ago

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.

gabalafou commented 1 month ago

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 commented 3 weeks ago

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

trallard commented 3 weeks ago

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

gabalafou commented 2 weeks ago

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: