Repository navigation
Conversation
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 in zensical.toml. Generated with the docs-tools convert_mkdocs_config command, which checked that Zensical reads the same configuration from the TOML files as from the YAML files.
Temporarily pin beeware-docs-tools to the Zensical migration branch (beeware/beeware-docs-tools#288); revert to beeware/main once that PR is merged. Remove the MkDocs-only DISABLE_MKDOCS_2_WARNING and NO_MKDOCS_2_WARNING settings from tox.ini, and ignore the docs/_build.*.toml files that docs-tools generates during a build.
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.
Moves Podium's documentation build 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-tools 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 will be reverted tobeeware/beeware-docs-toolsonce #288 is merged.Changes
docs/config.ymlanddocs/mkdocs.en.ymlare replaced bydocs/zensical.tomlanddocs/zensical.en.toml. They were generated with the docs-tools converter, which checked that Zensical reads the same configuration from the new files as it did from the YAML.docs/en/SUMMARY.md(literate-nav) is replaced by the nativenavsetting indocs/zensical.toml. The literate-nav plugin is no longer used.pyproject.toml: thedocsgroup is temporarily pinned to the docs-tools migration branch (see above).tox.ini: removed the MkDocs-onlyDISABLE_MKDOCS_2_WARNINGandNO_MKDOCS_2_WARNINGsettings..gitignore: ignores thedocs/_build.*.tomlfiles that docs-tools generates during a build.Verification
tox -r -e docsbuilds in strict mode with no issues. Strict mode does fail the build on a broken link.main:navinzensical.tomlinstead ofSUMMARY.md. The documentation style guide now refers to Zensical instead of MkDocs.Notes for reviewers
tox.inistill passes--source-code=stubstobuild_md_translations. docs-tools accepts this option but doesn't use it, either before or after #288, and Podium has nostubsdirectory. It could be removed, as it was in Toga and Rubicon, but I left it alone to keep this PR to the migration.navindocs/zensical.toml. Zensical doesn't warn about pages that are missing fromnav.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)