feat: Migrate documentation from Quarto to Zensical - #106
Open
D3f0 wants to merge 1 commit into
Open
Conversation
- Replace quartodoc with zensical + mkdocstrings-python - Convert all .qmd files to standard Markdown with pymdownx extensions - Create zensical.toml configuration (modern theme, navigation, mkdocstrings) - Generate API reference pages for all modules using mkdocstrings directives - Update tasks.py with new doc commands (docs_build, docs_serve, docs_watch) - Remove all Quarto artifacts (_quarto.yml, _extensions, .quarto, etc.) - Update .gitignore for Zensical output Built by the creators of Material for MkDocs, Zensical provides: - Faster builds (Rust-based) - TOML configuration - mkdocstrings for Python API docs - Modern theme with navigation tabs, instant loading, code copy
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
Migrates the project documentation from Quarto (.qmd files + quartodoc) to Zensical — the next-generation static site generator built by the creators of Material for MkDocs.
Changes
Configuration
zensical.tomlwith full project config (modern theme, navigation tabs, mkdocstrings plugin)quartodoc>=0.11.1withzensical>=0.0.41+mkdocstrings-python>=1.0.0in dev depsContent Migration
.qmdfiles to standard Markdown (.md)!!! warning,!!! tip)API Reference
::: moduledirectivesBuild System
tasks.pywith new commands:docs_build,docs_serve,docs_watchCleanup
_quarto.yml,_extensions/,.quarto/,objects.json, all generated reference.qmdfiles.gitignorefor Zensicalsite/outputVerification
✅
zensical buildcompletes successfully in ~0.3s with no issuesPreview locally