Builds failing

[mathieuboudreau]

I made two small changes this morning,

https://github.com/neuropoly/intranet.neuro.polymtl.ca/commit/a478d4de0db5c762075193d1080c67a223d04def https://github.com/neuropoly/intranet.neuro.polymtl.ca/commit/80e6c6b8bf90648d8b26542d1dc6074d4a0911e6

and both builds fail due to something that appears to be unrelated.

Here is the GitActions log for the most recent one: https://github.com/neuropoly/intranet.neuro.polymtl.ca/actions/runs/4331076531/jobs/7562731150#step:5:175

This is the last error message:

Extension error (pydata_sphinx_theme):
[172](https://github.com/neuropoly/intranet.neuro.polymtl.ca/actions/runs/4331076531/jobs/7562731150#step:5:173)
Handler <function update_and_remove_templates at 0x7f1d6214c9d0> for event 'html-page-context' threw an exception (exception: sidebar-logo.html)
[173](https://github.com/neuropoly/intranet.neuro.polymtl.ca/actions/runs/4331076531/jobs/7562731150#step:5:174)
make: *** [Makefile:20: html] Error 2
[174](https://github.com/neuropoly/intranet.neuro.polymtl.ca/actions/runs/4331076531/jobs/7562731150#step:5:175)
Error: Process completed with exit code 2.

It seems to be complainign about a file/setting that I didn't touch. I only see "sidebar-logo.html" in the config file but can't find the static file for it.

[mguaypaq]

Ok, I found the proximate cause and a quick fix. I'll push the quick fix now, and keep investigating for a better fix.

The proximate cause: the Python package sphinx-book-theme published a new release this weekend (v1.0.0), with breaking changes, so our build script is currently broken.

This was one of the few package version differences between a recent successful build and the current failing build.

The quick fix: temporarily pin sphinx-book-theme's version to be less than 1.0.0.

A better fix will be to figure out what changed in the theme, why it's unhappy with our docs specifically, and update things accordingly.

[mguaypaq]

The quick fix seems to be working, thankfully, so at least we can update the wiki again. I'll keep digging.

[mathieuboudreau]

Great! Thanks for figuring out the problem @mguaypaq !

[mguaypaq]

I was able to upgrade the theme, in these commits:

https://github.com/neuropoly/intranet.neuro.polymtl.ca/commit/ab9c69836482489a7d036151848536e76a7b617c https://github.com/neuropoly/intranet.neuro.polymtl.ca/commit/726bc36129393dfd852bae9ec095c3d0a135096d https://github.com/neuropoly/intranet.neuro.polymtl.ca/commit/5a8caf9e4f6d8a8245c0240ca953d75f6192dc5d

(plus a few extra commits to fix format warnings).

So now:

• We're on a newer version of sphinx.
• We're on a newer version of sphinx-book-theme (and its dependency pydata-sphinx-theme).
• We're migrated from the no-longer-maintained sphinx-panels to its recommended successor, sphinx-design.
• Our custom CSS is updated to the newer class names in the upgraded theme.

Hopefully I didn't break anything important during the change.