Repository navigation
chore(docs): migrate docs build from MkDocs to Zensical - #8585
Merged
Merged
Conversation
Zensical reads the existing mkdocs.yml, so the project structure stays the same. - replace mkdocs-material, mkdocs-git-revision-date-plugin and mkdocs-llmstxt with zensical (llms.txt is native now) - use theme variant classic to keep the Material look - self-host Ubuntu and Roboto Mono fonts instead of the privacy plugin - rename mkdocstrings 'import' to 'inventories' - fold core/metrics.md into core/metrics/index.md, both rendered to the same URL - switch workflows, Makefile and the docs Dockerfile to zensical
…age by digest only
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #8585 +/- ##
========================================
Coverage 96.93% 96.93%
========================================
Files 318 318
Lines 16005 16005
Branches 1420 1420
========================================
Hits 15514 15514
Misses 349 349
Partials 142 142 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
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.

Issue number: closes #8195
Summary
Changes
Moves the docs build from MkDocs to Zensical. Zensical reads our
mkdocs.ymlas is, so the project layout, nav, snippets, annotations, tabs, mermaid, mkdocstrings API pages and themain.htmloverride all stay the same. I built the site with both tools and compared page by page: same 109 pages, same 81 API objects, same code blocks and annotations. Build time went from 26s to 8s.zensical==0.0.71replacesmkdocs-material,mkdocs-git-revision-date-pluginandmkdocs-llmstxt.llms.txtandllms-full.txtare generated natively, no config change.theme.variant: classickeeps the Material look. The defaultmodernvariant is the new visual we saw in May.privacyplugin does not exist in Zensical, so Ubuntu and Roboto Mono are now self-hosted indocs/stylesheets/fonts/(latin + latin-ext, 737 KB) withtheme.font: false. The built site makes no request to Google Fonts.git-revision-datehas no replacement. The "Last update" line is gone.importis nowinventories. The old key was removed inmkdocstrings-python2.x.core/metrics.mdandcore/metrics/index.mdrendered to the same URL. MkDocs let one overwrite the other, Zensical fails the build. The EMF content now lives incore/metrics/index.md(same URL, same title), the duplicate nav entry is gone, and the internal links were updated.Makefileanddocs/Dockerfilecallzensicalinstead ofmkdocs.docs/requirements.txtwas regenerated with hashes and installs on Python 3.12 and 3.14.zensicalis only installed on Python 3.11+ in the dev group, which is its minimum.User experience
No visual change intended. Things to look at when reviewing:
make docs-localandmake docs-local-dockerwork the same way, just running Zensical.Zensical is still 0.0.x until the 0.1.0 line on November 5, so the version is pinned. Material for MkDocs reaches end of life on May 5, 2027.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.