Repository navigation
Conversation
Convert docs/config.yml, docs/mkdocs.en.yml and docs/en/SUMMARY.md into Zensical-native docs/zensical.toml and docs/zensical.en.toml, with the navigation as a native nav setting, using the docs-tools converter. Remove the MkDocs 2 warning environment variables from tox.ini, drop the SUMMARY.md rumdl exclusion, and ignore the generated docs/_build.*.toml files. Temporarily pin beeware-docs-tools to the Zensical migration branch.
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 Cricket's documentation from MkDocs and Material for MkDocs to Zensical, using Zensical-native configuration.
This depends on beeware/beeware-docs-tools#288, which moves the shared docs build to Zensical. Until that PR merges,
beeware-docs-toolsis temporarily pinned to its branch (kattni/beeware-docs-tools@tooling/zensical-migration). The pin will be reverted tobeeware/mainonce beeware/beeware-docs-tools#288 is merged.Changes
docs/config.yml,docs/mkdocs.en.ymlanddocs/en/SUMMARY.mdare replaced bydocs/zensical.tomlanddocs/zensical.en.toml, generated with the docs-tools converter. The literate-navSUMMARY.mdis now a nativenavsetting indocs/zensical.toml, so new pages are added there.tox.ini: removed the MkDocs-onlyDISABLE_MKDOCS_2_WARNINGandNO_MKDOCS_2_WARNINGenvironment variables.pyproject.toml: temporary docs-tools pin (see above), and thedocs/en/SUMMARY.mdrumdl exclusion removed..gitignore: ignores thedocs/_build.*.tomlfiles that docs-tools generates during a build.Verification
The strict Zensical build (
tox -e docs) passes with no issues. Compared against a MkDocs build ofmain:navinzensical.tomlinstead ofSUMMARY.md, and Zensical instead of MkDocs.objects.invand the image are identical.Notes for reviewers
pymdownx.magiclinkreposetting is"website", so a bare issue reference in Cricket's docs links to the website repository rather than Cricket. This predates the migration and is unchanged here.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)