Repository navigation
Conversation
Temporary: revert to beeware/main once beeware/beeware-docs-tools#288 is merged.
Generated with docs-tools' convert_mkdocs_config: docs/config.yml and docs/mkdocs.en.yml become docs/zensical.toml and docs/zensical.en.toml, and the literate-nav SUMMARY.md becomes the native nav setting.
Drop the MkDocs 2 warning environment variables and the --source-code arguments (now ignored by docs-tools) from tox, and ignore the generated docs/_build.*.toml files.
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.
Converts the toga-chart documentation build from MkDocs and Material for MkDocs to Zensical, using Zensical-native configuration.
This depends on beeware/beeware-docs-tools#288. docs-tools is temporarily pinned to that PR's branch (
kattni/beeware-docs-tools@tooling/zensical-migration) in thedocsdependency group; the pin will be reverted tobeeware/mainonce #288 is merged.Changes
docs/config.ymlanddocs/mkdocs.en.ymlare replaced bydocs/zensical.tomlanddocs/zensical.en.toml, generated with docs-tools'convert_mkdocs_config. Its equivalence check reported the converted configuration as equivalent to the YAML (the only note was the order of the Markdown extensions).docs/en/SUMMARY.md(literate-nav) is replaced by the nativenavsetting indocs/zensical.toml. New pages now need to be added tonavby hand.pyproject.toml: docs-tools pinned to the migration branch (temporary), anddocs/en/SUMMARY.mdremoved from the rumdl exclude list.tox.ini: removed the MkDocs-onlyDISABLE_MKDOCS_2_WARNING/NO_MKDOCS_2_WARNINGsettings, and the--source-codearguments, which docs-tools now ignores..gitignore: ignores the generateddocs/_build.*.tomlfiles.Verification
tox -r -e docs,docs-lintbuilds in strict mode with no issues, and the spelling check passes.main:navinzensical.tomlinstead ofSUMMARY.md, and refers to Zensical instead of MkDocs.toga_chart.Chart) renders identically, andobjects.inv,sitemap.xmland the images are byte-identical.Notes for reviewers
beeware/mainonce Migrate the documentation tooling to Zensical beeware-docs-tools#288 has merged.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)