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

Jupyter book build issue - causing nightly build to fail #160

Closed
rmshkv opened this issue Feb 28, 2024 · 11 comments
Closed

Jupyter book build issue - causing nightly build to fail #160

rmshkv opened this issue Feb 28, 2024 · 11 comments
Labels
bug Issues that present a reasonable conviction there is a reproducible bug.

Comments

@rmshkv
Copy link
Member

rmshkv commented Feb 28, 2024

In the nightly build in this repo as well as other cookbooks, the Jupyter Book build step is failing with an error coming from Sphinx (full error here):

AttributeError: module 'docutils.nodes' has no attribute 'meta'
@rmshkv rmshkv added the bug Issues that present a reasonable conviction there is a reproducible bug. label Feb 28, 2024
@brian-rose
Copy link
Member

Thanks for the report @rmshkv, I noticed this too.

I'm not sure if this is related to issues with our Sphinx theme ( ProjectPythia/sphinx-pythia-theme#39). @erogluorhan has been working on getting the theme up to date (ProjectPythia/sphinx-pythia-theme#58).

@ktyle
Copy link
Contributor

ktyle commented Feb 28, 2024

i'll take a look ASAP

@ktyle
Copy link
Contributor

ktyle commented Feb 28, 2024

Looks like that when pip is installing our creaky old sphinx-pythia-theme, it is now updating the various sphinxcontrib libraries that are pinned in the conda environment from ProjectPythia/cookbook-actions#92 . Wonder if there is a way to pin libraries in pip as well?

@brian-rose
Copy link
Member

Looks like that when pip is installing our creaky old sphinx-pythia-theme, it is now updating the various sphinxcontrib libraries that are pinned in the conda environment from ProjectPythia/cookbook-actions#92 . Wonder if there is a way to pin libraries in pip as well?

I'm not pip expert, but I think that is usually done in the requirements.txt file.

This is an unforunately legacy of the fact that the conda-forge recipe for our sphinx theme has been broken for years.

@brian-rose
Copy link
Member

It's becoming more and more clear to me that we need to find a way to separate the environment description for the book build from the environment description for the notebook execution.

The first is generic and should be identical for every cookbook. It should be contained within a "Cookbook Infrastructure" package that can be maintained and versioned independently of the content of each Cookbook.

Whatever temporary fix we come up with here (possibly like ProjectPythia/ERA5_interactive-cookbook#9) is going to need to be propagated across every existing Cookbook repo -- and then removed again once the upstream dependency issues get sorted out.

Related to #118 and ProjectPythia/cookbook-gallery#86

@ktyle
Copy link
Contributor

ktyle commented Mar 1, 2024

Assuming we can deploy a new sphinx-pythia-theme in conda-forge that has appropriate dependencies which play nicely with current versions of Sphinx and Jupyterbook, I think the only "book-specific" packages that we would need are jupyter-book and sphinx-pythia-theme. But that assumes of course that the new sphinx-pythia-theme does not again fall victim to obsolescence, necessitating ever-more complicated pins!

@ahuang11
Copy link
Contributor

ahuang11 commented Mar 14, 2024

Any fixes for this? I'm trying to update ProjectPythia/landsat-ml-cookbook#22 and not sure how to proceed; should I merge with this broken?

Edit: oh I think I just need to follow https://github.com/ProjectPythia/ERA5_interactive-cookbook/pull/9/files

@ktyle
Copy link
Contributor

ktyle commented Mar 15, 2024

@ahuang11 let's see how @erogluorhan 's work with ProjectPythia/sphinx-pythia-theme#58 looks with this cookbook.

@brian-rose
Copy link
Member

Nightly build is finally passing again with the release of sphinx-pythia-theme v2024.3.0!

@erogluorhan
Copy link
Member

I think we can close this now as we've update our Pythia theme, which has fixed this and several other repos' nightly builds. See the discussion for more information about the theme update.

@github-project-automation github-project-automation bot moved this from Backlog to Done in Pythia Projects Board Apr 1, 2024
@erogluorhan
Copy link
Member

Hey @rmshkv, for using the updated theme in your ongoing cookbook work, please do not forget to check out the How to transition existing cookbooks part of the discussion to see how cookbook-template has been updated to start using the updated theme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues that present a reasonable conviction there is a reproducible bug.
Projects
Status: Done
Development

No branches or pull requests

5 participants