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, using the docs-tools converter. The literate-nav navigation becomes the nav setting. Drop the duplicate "Using xbuild" nav entry, which pointed at the How-to guides index page a second time; Material hid it, but Zensical shows it. Remove the MkDocs-only settings from tox.ini, the --source-code argument that docs-tools no longer uses, and SUMMARY.md from the rumdl excludes. Ignore the docs/_build.*.toml files that builds generate. Temporarily pin beeware-docs-tools to the Zensical migration branch, until beeware/beeware-docs-tools#288 is merged.
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 xbuild's documentation from MkDocs and Material for MkDocs to Zensical 0.1.0, with Zensical-native configuration files.
This depends on beeware/beeware-docs-tools#288, which moves the shared docs build to Zensical. Until that PR is merged, the
docsdependency group is temporarily pinned to its branch (kattni/beeware-docs-tools@tooling/zensical-migration). The pin is reverted tobeeware/beeware-docs-tools@mainonce #288 merges.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 converter checked that the result is equivalent to the configuration Zensical reads from the YAML files. The literate-nav navigation is now thenavsetting indocs/zensical.toml.xbuild" nav entry is removed. It pointed at the How-to guides index page a second time. Material hid it (but gave the How-to page a "Previous" link to itself); Zensical shows it as a second sidebar link.tox.ini: removed the MkDocs-onlyDISABLE_MKDOCS_2_WARNINGandNO_MKDOCS_2_WARNINGsettings, and the--source-code=srcargument, which docs-tools no longer uses.pyproject.toml: the temporary docs-tools pin, anddocs/en/SUMMARY.mdremoved from the rumdl excludes..gitignore: ignores thedocs/_build.*.tomlfiles that builds generate.Verification
The strict Zensical build passes with no issues. Compared with the MkDocs build of
main:navinzensical.tomlinstead ofSUMMARY.md, and Zensical instead of MkDocs.objects.invis byte-identical. xbuild has no API reference pages, so mkdocstrings generates no content.Notes for reviewers
xbuild" nav entry keeps the sidebar the same as before. If a sidebar entry for that section is wanted, it could point athow-to/index.md#using-xbuildinstead.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)