chore(docs): replace mkdocs with zensical - #21
Merged
Conversation
Drop mkdocs/mkdocs-material/mkdocstrings in favor of zensical, a modern static site generator built by the Material for MkDocs team. mkdocs.yml is kept as-is since zensical reads it natively via its MkDocs compatibility layer (theme, search, and mkdocstrings plugin all supported unmodified). zensical has no bundled gh-deploy equivalent, so deploy now runs ghp-import directly against the built site/ dir (mirroring what mkdocs gh-deploy did internally). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QaJZCwGxe4YnHaf3Soxdqn
2 tasks
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
1 participant
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.
Summary
mkdocs.ymlkept as-is — zensical reads it natively via its MkDocs compatibility layer (material theme, search, mkdocstrings plugin all work unmodified, verified locally)make doc-deploynow runsghp-importdirectly against the builtsite/dir (same mechanism mkdocs used internally)Test plan
uv lockresolves clean (zensical is python>=3.10-only, marker-gated so it's skipped in the py3.9 nox test env)uv run zensical buildsucceeds,mkdocstringsautodoc renders (::: samplein docs/index.md produces real API doc HTML)uv run zensical servestarts and serves the built site (200 response)ruff format --check/ruff checkcleandocs.ymlworkflow (deploy to gh-pages) only triggers on push tomaster/merge — can't be exercised from this PR, only verified locally