sphinx-multiversion and toggle-primary-sidebar.html Template not Found

[adam-grant-hendry]

I reviewed issue #234 and am still having trouble using sphinx-multiversion with pydata-sphinx-theme. I posted a complete issue, including system info, MRE, and traceback in sphinx-multiversion #106, but the "long-story-short" is jinja2 cannot find a template toggle-primary-sidebar.html:

Handler <function update_and_remove_templates at 0x000002467AA35670> for event 'html-page-context' threw an exception (exception: toggle-primary-sidebar.html)

Is this a template I need to add/override in my _templates folder? It's not mentioned in the pydata-sphinx-theme nor sphinx-multiversion docs (as far as I can tell).

Any help would be appreciated. Is sphinx-multiversion is unnecessary since pydata-sphinx-theme added support for html_sidebars (See: PR #248)? Does anyone know how to implement multi-versioned docs with the pydata-sphinx-theme?

[drammock]

IIUC sphinx-multiversion builds multiple versions of your docs simultaneously (and I think adds some sort of version switcher to every docs page). For all the projects I work on, there is no need to rebuild old versions of the docs over and over again, since the content won't ever change. So we build with regular sphinx_build, "freeze" each docs version once a release is made, store them at separate URLs, and use the PyData Sphinx Theme's version switcher functionality to switch among them.

• example site: https://mne.tools
• how it's all stored: https://github.com/mne-tools/mne-tools.github.io

I'll try to have a deeper look at your particular errors when I can, but FYI I'm super booked up the next 2 weeks (leading weeklong workshop, then traveling for a week)

[adam-grant-hendry]

@drammock Thank you so much! And no worries, this is open source and most developers are very busy. I'm simply grateful for the help and response!

Very good point about rebuilding old versions (that's a waste of time). I look forward to reviewing your repo and seeing if I can model the same behavior (thank you for the links!).

Side Note:

For future readers, it seems there is now a sphinx-multiversion-contrib repo which is:

a fork of the original project sphinx-multiversion. The fork was made at version 0.2.4, and all newer versions represent new features and bug fixes. See CHANGELOG.rst for details.

However, there is no python 3.8 support (even though the projected EOL for 3.8 is 2024-10), the Issues tab has been disabled, and there is no CONTRIBUTING.md, so the whole package is a bit of a hot mess ATM.

[adam-grant-hendry]

Also for future readers, a link to the pydata-sphinx-theme Version Switcher docs which I was looking for (thanks again @drammock !)

[adam-grant-hendry]

See: Issue #1511

[adam-grant-hendry]

@drammock Even with the changes made in #1511 , I still get the following error when trying to specify where to display the switcher:

Handler <function update_and_remove_templates at 0x000001A39B8279D0> for event 'html-page-context' threw an exception (exception: version_switcher.html)

Can you please advise?

[adam-grant-hendry]

Can you please advise?

Doh! I used an underscore:

version_switcher

needed to be a hyphen:

version-switcher