Sphinx Pythia Theme Updated! Check this out for important information

[erogluorhan]

Dear Pythia community!

Now as we have updated the outdated sphinx-pythia-theme and released it on Conda and PyPI, we'd like to share some important information about it and ask your feedback below:

1. We ask your feedback
2. How to transition existing cookbooks
3. How to write new cookbooks

[erogluorhan]

We ask your feedback:

First of all, this theme update is a huge jump from Sphinx<5 to Sphinx >=7 that covers a lot of significant infrastructural change, which we tried to limit its impact on Pythia's user-facing online assets (portal, cookbooks, foundations, etc.). Though, as with any huge theme update like this, there might be functional and cosmetic etc. issues.

Please add a comment below in this cell if you observe any issues:

[erogluorhan]

Let me go first:

Dropdown buttons in the Resource Gallery and Cookbook Gallery are not working.

[erogluorhan]

In mobile version of the portal, navigation bar items are not showing up

[r-ford]

Code blocks are difficult to read in dark mode:

[erogluorhan]

f## How to transition existing cookbooks:

We have already transitioned the cookbook-template into the updated theme in this pull request: Start using the updated theme.

Here is a checklist for this transition of the existing cookbooks:

• Write something next to the cookbook's name below to show you will be / are working on it (GitHub username, issue or PR link, etc.)
• Mark it when completed
• Enter a comment below if you have any issues etc.

Checklist:

• CESM LENS on AWS Cookbook (Still issues after this PR, see below comment)) (new PR)
• CMIP6 Cookbook (@jukent )
• HRRR AWS Cookbook (@jukent)
• Radar Cookbook (@jukent) (broken)
• Intake Cookbook (@jukent) (PR)
• Landsat ML Cookbook (@jukent)
• Kerchunk Cookbook (@jukent)
• xbatcher for Machine Learning Part 1 Cookbook (@jukent) (PR)
• Dask Cookbook (PR)
• ARCO ERA-5 Interactive Visualization Cookbook (PR)
• Web Map / Feature Services Cookbook (@jukent) (PR) failing link check
• Sentinel-2 L2A Interactive Dashboard (@jukent) (PR)
• (re)Gridding with xarray (@jukent) (PR)
• Advanced Visualization Cookbook (@jukent) (PR)
• Unstructured Grids Visualization Cookbook (PR)
• NA-CORDEX Visualization Cookbook (@jukent) (PR)

[jukent]

Radar cookbook theme is merged, PR to address failing build. Merged because it passed the PR tests, but is failing locally and to publish. @mgrover1 could you or someone more familiar with the radar packages look at this?

[mgrover1]

I fixed the radar cookbook with the latest env - an older version of a package was cached.

[jukent]

Should we merge the PRs for the new theme even if the build is failing for other reasons? Only Intake, Xbatcher, and EOFs are still failing.

@cmdupuis3 @mgrover1 @mgrover1 or @r-ford do any of you feel confident addressing the failure in Xbatcher?

[cmdupuis3]

@jukent So atm, the xbatcher cookbook doesn't actually run xbatcher by default, so that shouldn't be an issue. I believe the hangup is mostly around data access, although that code was relying on intake as well. In any case, I think the plan was to wait for the data allocation to open up so I can put the needed files on it.

[jukent]

Great thanks. I'll merge only the theme changes in that case.

[erogluorhan]

How to write new cookbooks:

As before, use our cookbook-template that we have already revised to use the updated new theme. Please see the Project Pythia Cookbook Contributor’s Guide for further information.

[jukent]

More Cookbooks that need updating (some on gallery, some not):

• VAPOR
• EOFs (PR) broken
• Marine Heatwave
• MetPy
• XGCM
• Physical Oceanography
• Packaging

[jukent]

@r-ford could you look more at why the EOFs cookbook is failing?

[r-ford]

Probably related to recent changes in the xeofs package, so I'll try to fix it soon.

[brian-rose]

Our Cook-off site also needs updating to the new theme. It is currently failing its nightly build. I will address this shortly.

Update: here's the PR