fix: drop mkdocs nav entries for notebooks the book never builds - #539
Merged
Conversation
The `Notebooks:` nav section pointed at notebooks/Experiment1.html through Experiment5.html. Those pages have never been built or published: both https://tschm.github.io/cs/notebooks/Experiment1.html and the marimo/notebooks/ path that book/_toc.yml references return 404 today. The book build reports why, and has all along: [WARN] no marimo folder; skipping notebook export `rhiza-task` exports notebooks from `marimo_folder`, which this repo leaves unset. It therefore resolves to the CLI default `docs/notebooks`, which does not exist here -- the notebooks live under book/marimo/notebooks, named by `source_folder`. So the export no-ops and the five nav targets dangle. rhiza v1.6.0 adds a `book-nav` gate that catches exactly this, which is what surfaced it. Removing the entries makes the nav describe what the site actually publishes. Not fixed here: setting `marimo-folder` so the notebooks really do publish. Both the export and rhiza_marimo.yml's matrix glob *.py with no notebook filter, so pointing them at book/marimo/notebooks would also pick up optimize.py and preamble.py, which are plain modules -- the matrix would run `uv run --script` on files with no PEP 723 header and fail. Separating them means moving preamble.py out of the notebooks' sys.path, which all five notebooks and optimize.py import from. Left as follow-up work.
|
Warning Review limit reachedNext included review available in 40 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Unblocks #538 (the rhiza v1.6.0 update), which fails
book / build.What's wrong
mkdocs.ymlnavigated to five notebook pages the book never builds:These have never resolved. Both paths are 404 on the live site right now:
https://tschm.github.io/cs/notebooks/Experiment1.html→ 404https://tschm.github.io/cs/marimo/notebooks/Experiment1.html→ 404 (the pathbook/_toc.ymllinks to)The book build has been saying so all along, in a warning nothing gated on:
rhiza-taskexports notebooks frommarimo_folder. This repo never sets it, so itresolves to the CLI default
docs/notebooks, which doesn't exist here — the notebookslive under
book/marimo/notebooks, which is named bysource_folder. The exportno-ops, and the five nav entries dangle.
rhiza v1.6.0 adds a
book-navgate that checks every nav target against the builtsite, which is what surfaced this:
What this does
Removes the five entries, so the nav describes what the site actually publishes. The
remaining 7 nav targets all resolve. No other file changes.
What this deliberately does not do
Make the notebooks publish. That looks like a one-line
marimo-foldersetting, but itisn't:
folder.glob("*.py")) andrhiza_marimo.yml's matrix(
find -maxdepth 1 -name "*.py") glob every Python file with no notebook filter.book/marimo/notebooksalso holdsoptimize.pyandpreamble.py, which are plainmodules, not marimo notebooks, and carry no PEP 723 header. The matrix runs
uv run --scripton each match, so it would go from 0 jobs to 7 with 2 failures.preamble.pyoff the notebooks'sys.path, and allfive notebooks plus
optimize.pydofrom preamble import …. It would also touchthe ty
extra-pathsheaders, the 1:1 table indocs/development/TEST_LAYOUT.md,scripts/check_test_layout.py, andsource_folder.Worth doing as its own change if those pages should be on the site. Filed separately.