Repository navigation
Conversation
Generated with beeware-docs-tools' convert_mkdocs_config. The literate-nav SUMMARY.md is replaced by an explicit nav in zensical.toml, and the exclude plugin is replaced by exclude_docs for the snippets directory.
Pins beeware-docs-tools to its Zensical migration branch (temporary, until that change merges), drops the mkdocs-redirects and mkdocs-exclude plugins (Zensical implements both natively), removes the MkDocs 2 warning variables and the no-longer-needed --source-code arguments, and ignores the generated build configs.
3 tasks done
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.
Migrates Toga's documentation build from MkDocs to Zensical (0.1.0), using the Zensical support in beeware-docs-tools.
Depends on beeware/beeware-docs-tools#288. Until that merges, the
docsdependency group pins beeware-docs-tools to the migration branch (kattni/beeware-docs-tools@tooling/zensical-migration), with aTEMPORARYcomment. The pin will be reverted to beeware-docs-toolsmainonce #288 merges, before this PR is merged.Changes
docs/config.ymlanddocs/mkdocs.en.ymlare converted todocs/zensical.tomlanddocs/zensical.en.tomlwith docs-tools'convert_mkdocs_config.docs/en/SUMMARY.mdis replaced by an explicitnavinzensical.toml. Its wildcard sections (tutorial/*,topics/*and thereference/api/*subsections) are expanded to explicit page lists.excludeplugin is replaced by coreexclude_docs = "snippets/".mkdocs-redirectsandmkdocs-excludeare dropped from thedocsgroup; Zensical implements both natively. Theredirectsconfiguration is unchanged.--source-codearguments (docs-tools now resolves the mkdocstringspathsfrom the repo root)..gitignoreignores the generateddocs/_build.*.tomlconfigs; the rumdl exclude no longer listsSUMMARY.md;AGENTS.mddescribes the Zensical setup.Verification
tox -e docs(strict) passes against docs-toolsb3a1e03.main:objects.invis identical (3,499 entries), and so are the external cross-references to Python and Pillow.Notes for reviewers
navindocs/zensical.toml. Zensical 0.1.0 doesn't implement MkDocs' "page not in nav" (omitted_files) validation, so a page missing fromnavbuilds silently rather than failing the strict build. Is that acceptable, or should we add a check?flavor = "mkdocs", because Zensical uses the same Markdown dialect.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)