fix: resolve MyST build warnings - #11
Conversation
Three warnings appear when running `myst build`:
1. basic_lessons/README.md "missing heading depth 2" — the page title is
depth 1 but "Using this book" and "Contents" jumped straight to depth 3,
skipping depth 2. Demote them to `##`.
2. lesson0_tutorial.md "Language is not defined for code block" — the
verification {code-cell} had no language. Add `python` to the directive
(``{code-cell} python``), which MyST records as the code language.
3. lesson2_tutorial.md "textEnv, Too few columns specified in the {array}
column argument" — the 4x4 homogeneous transformation matrices H_a and
H_a_b declared {array}{ccc} (3 columns) but have 4. Change to {cccc}.
Verified with a full `myst build --execute --html`: no warnings remain.
Co-authored-by: openhands <openhands@all-hands.dev>
AGENTS.md content was already accurate against the current repo state;
no corrections were needed. Added a short "Keeping the build warning-free"
note under Building & Testing documenting the three MyST warning classes
fixed in this PR, including the non-obvious point that a bare {code-cell}
only warns for lessons referenced as .md (lesson 0) — lessons 1-5 are
.ipynb-referenced and Jupyter carries the Python language.
Co-authored-by: openhands <openhands@all-hands.dev>
AGENTS.md review + small additionAs requested, I audited
So no corrections were needed. I made one focused addition — a short "Keeping the build warning-free" subsection under Building & Testing — that captures the three MyST warning classes fixed in this PR so they don't regress:
The third bullet records a non-obvious nuance I verified while debugging: only lesson 0 warns about bare
|
2 participants
Summary
Running
myst buildproduced three warnings. This PR fixes all of them, so the build is now clean.The three warnings and their fixes
missing heading depth 2basic_lessons/README.md##.Language is not defined for code blockbasic_lessons/lesson0_tutorial.md{code-cell}had no language tag, so the rendered code node had nolang.pythonto the directive →{code-cell} python. Verified MyST records this as the code language (all other fenced blocks keep their own).textEnv, Too few columns specified in the {array} column argument(×4, two math blocks)basic_lessons/lesson2_tutorial.mdH_aandH_a_bdeclared{array}{ccc}(3 columns) but actually have 4 columns.{array}{cccc}.Verification
myst build --execute --html(all 17 pages, all code cells executed) before the fix → the three warnings above were present.{array}block declares fewer columns than it actually contains (the 2×2 and 3×3 blocks are fine — 3 ≥ their column count, which is why they never warned).README/page has a heading-depth gap.Notes
Server started on port 3000) failing to connect in a headless environment — it happens onmaintoo and is unrelated to these warnings. The actual site build succeeds and emits the pages.Related: #10 (merged).