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

Upgrade to latest pydata-sphinx-theme and myst-nb #307

Merged
merged 11 commits into from
May 2, 2024
Merged

Conversation

maximlt
Copy link
Collaborator

@maximlt maximlt commented Apr 24, 2024

  • Bumped the minimum pin of myst-nb, myst-parser, sphinx and pydata-sphinx-theme as this is what I tested. Let's see if our environments can solve with these pins.
  • pydata-sphinx-theme updated (for performance reasons) their code that decides whether to include a toctree in the sidebar, which broke our approach. Instead, I used an approach (found it in the IPywidgets repo) that consists of adding a single sidebar template dedicated to the index page. It's configured in the shared conf.py file, nbsite users can easily override it.
  • Had to update a Sphinx patch, I added a test to catch that regression.

  • Section Navigation also needs to be removed from the non-index sidebars.
  • Migrated the front-end jQuery code to pure JS that switches between "backends" in a gallery, as the newer versions of the stack doc build stack no longer include jQuery.

@hoxbro
Copy link
Collaborator

hoxbro commented Apr 24, 2024

I assume you are already aware, but just if you are not the myst-nb 1 gave problems for panel and holoviews documentation build: #292

@maximlt maximlt marked this pull request as draft April 24, 2024 15:27
@maximlt
Copy link
Collaborator Author

maximlt commented Apr 30, 2024

I assume you are already aware, but just if you are not the myst-nb 1 gave problems for panel and holoviews documentation build: #292

I'm an idiot I read geoviews somehow. Then I'll guess I'll build HoloViews and see how that goes.

@maximlt maximlt marked this pull request as ready for review May 2, 2024 19:00
@maximlt maximlt merged commit addd063 into main May 2, 2024
5 checks passed
@maximlt maximlt deleted the upgrade_theme_myst branch May 2, 2024 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants