Move the documentation from MkDocs to Zensical - #305
Merged
Conversation
Material for MkDocs reaches end of life on 2026-11-05, after which it gets no
further security fixes. Zensical is its successor from the same author, MIT and
without the sponsorware model, and mkdocstrings works on it -- mkdocstrings' own
site is built with Zensical and its author is on the team.
mkdocs-jupyter has no Zensical equivalent, and it was the only plugin without
one. The notebooks are now rendered to Markdown with nbconvert, preserving their
stored outputs exactly as `execute: false` did. All code, all outputs and all
seven images survive; the 23-27% word-count drop on those pages is entirely
mkdocs-jupyter's In[n]/Out[n] cell prompts. The rendered Markdown is a build
artefact rather than a committed file -- docs/examples/build.py regenerates it,
CI runs that before building, and .gitignore keeps it out -- so it cannot drift
from the notebook it came from.
Two things surfaced by the move rather than caused by it:
- mccode_antlr.Flavor was cross-referenced from getting-started.md but
documented nowhere, so the link had no target. MkDocs logged a warning and
carried on; Zensical --strict aborts, with the file, line and column. Flavor
is public and used in nearly every example, so it is now documented on the
Assembler page and the reference resolves.
- docs/examples/display_geometry.ipynb was absent from the nav but still built
and published at its URL. It is now in the nav, where its being published is
at least deliberate.
The workflow moves from `mkdocs gh-deploy --force` -- which pushes to a gh-pages
branch and needs contents:write -- to the Pages artifact flow, and now builds on
pull requests too, so broken documentation fails before it merges rather than
after.
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.
Material for MkDocs reaches end of life on 2026-11-05, after which it gets no further security fixes. Zensical is its successor from the same author, MIT and without the sponsorware model, and mkdocstrings works on it -- mkdocstrings' own site is built with Zensical and its author is on the team.
mkdocs-jupyter has no Zensical equivalent, and it was the only plugin without one. The notebooks are now rendered to Markdown with nbconvert, preserving their stored outputs exactly as
execute: falsedid. All code, all outputs and all seven images survive; the 23-27% word-count drop on those pages is entirely mkdocs-jupyter's In[n]/Out[n] cell prompts. The rendered Markdown is a build artefact rather than a committed file -- docs/examples/build.py regenerates it, CI runs that before building, and .gitignore keeps it out -- so it cannot drift from the notebook it came from.Two things surfaced by the move rather than caused by it:
mccode_antlr.Flavor was cross-referenced from getting-started.md but documented nowhere, so the link had no target. MkDocs logged a warning and carried on; Zensical --strict aborts, with the file, line and column. Flavor is public and used in nearly every example, so it is now documented on the Assembler page and the reference resolves.
docs/examples/display_geometry.ipynb was absent from the nav but still built and published at its URL. It is now in the nav, where its being published is at least deliberate.
The workflow moves from
mkdocs gh-deploy --force-- which pushes to a gh-pages branch and needs contents:write -- to the Pages artifact flow, and now builds on pull requests too, so broken documentation fails before it merges rather than after.