Repository navigation
Conversation
… settings. docs-tools is temporarily pinned to the branch of beeware/beeware-docs-tools#288, which builds the documentation with Zensical. The pin is reverted once that PR is merged. Zensical implements redirects natively, so mkdocs-redirects is no longer needed. The MkDocs 2 warning variables in tox.ini are no longer needed. The build's temporary configuration files are ignored.
Generated with docs-tools' convert_mkdocs_config. docs/config.yml and the per-language docs/mkdocs.<lang>.yml files become docs/zensical.toml and docs/zensical.<lang>.toml. The literate-nav docs/en/SUMMARY.md becomes the native nav setting in docs/zensical.toml. The navigation titles' translations in docs/locales/*/translations.po are migrated to entries with the "navigation" context, which nav titles use. Entries that only came from SUMMARY.md are removed. No other entry is changed.
The converter kept each language's literal site_url in its language file, where it isn't a per-language setting and produces a warning. docs-tools adds the language directory to the base site_url for each translation, so setting https://tutorial.beeware.org/ once gives the same site URL for every language.
In SUMMARY.md, "Going further" was both a section label and the title of the section's index page, and de, es, zh_CN and zh_TW translated the two differently. With navigation.indexes, the sidebar showed the section label's translation, but the converter migrated the index page's. The navigation entry now has the section label's translation (and its fuzzy flag), so the sidebar is unchanged.
3 tasks done
This branch has not been deployed
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.
Moves the tutorial's documentation from MkDocs and Material for MkDocs to Zensical, with 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) inpyproject.toml. The pin is reverted tobeeware/beeware-docs-toolsonce #288 is merged.Weblate must be locked and synced before this is merged. The
translations.pofiles change in all 7 languages (de, es, fr, it, pt, zh_CN, zh_TW), so merging while Weblate has pending changes would conflict.Changes
docs/config.ymlanddocs/mkdocs.<lang>.ymlare replaced bydocs/zensical.tomlanddocs/zensical.<lang>.toml. These were generated with docs-tools'convert_mkdocs_config, which checked the result against the YAML for every language.docs/en/SUMMARY.md(literate-nav) is replaced by the nativenavsetting indocs/zensical.toml.msgctxt "navigation", whichnavtitles use. In every language:SUMMARY.mdare removed.site_urlis set once inzensical.toml. docs-tools adds<lang>/for each translation, so the canonical URLs and sitemaps are the same as before.redirectssettings are kept, because Zensical implements redirects natively. Themkdocs-redirectsdependency group is removed.DISABLE_MKDOCS_2_WARNINGandNO_MKDOCS_2_WARNINGsettings are removed fromtox.ini.docs/_build.*.tomlis added to.gitignore, and the rumdl ignore forSUMMARY.mdis dropped.Verification
tox -r -e docs-all: all 8 languages build in strict mode with "No issues found".mainwith the current docs-tools, in every language:/SUMMARY/page.build_pot_translations, thenbuild_po_translationsfor all 7 languages, without DeepL)::::strings appear.titles.mdline references.Notes for reviewers
SUMMARY.md, this was both a section label and its index page's title, and de, es, zh_CN and zh_TW translated the two differently. MkDocs showed the section label's translation in the sidebar, but the index page's in that page's<title>and in the previous/next footer links. One navigation entry can't reproduce both. I kept the sidebar wording (shown on every page), so in those 4 languages the topics page's<title>, and 2 footer links, now use the sidebar wording (for example German "Weiterführende Informationen" instead of "Weiterführend").extra.alternate, 中文(简体) haslang = "zh-Hant"(Traditional Chinese);zh-Hansis probably intended. This is carried over unchanged, to keep this PR a straight migration.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)