Repository navigation
Conversation
Generated with beeware-docs-tools' `convert_mkdocs_config`, which checked that the TOML configuration is equivalent to what Zensical read from the YAML files. - docs/config.yml is now docs/zensical.toml. - docs/mkdocs.en.yml is now docs/zensical.en.toml. - The literate-nav navigation in docs/en/SUMMARY.md is now the native `nav` setting in docs/zensical.toml, and the literate-nav plugin is removed. - The Material for MkDocs `yaml-language-server` schema comment is dropped.
- tox.ini: drop the MkDocs 2.0 warning environment variables, and the `--source-code=stubs` arguments; docs-tools now resolves the mkdocstrings source paths from the repository root. - .gitignore: ignore the per-language configuration files that docs-tools writes to docs/ during a build. - AGENTS.md: describe the docs as built with Zensical, configured by docs/zensical.toml and docs/zensical.<lang>.toml.
The Zensical build support in beeware-docs-tools isn't merged yet (beeware/beeware-docs-tools#288). Revert this to beeware/main once it is.
…laude/zensical-migration-8fdf88 # Conflicts: # tox.ini
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 Rubicon's documentation build from MkDocs and Material for MkDocs to Zensical, as part of the BeeWare-wide docs migration. The configuration now uses Zensical's native TOML format instead of MkDocs YAML.
This depends on beeware/beeware-docs-tools#288, which moves the shared docs tooling to Zensical. Until that PR merges, the
docsdependency group is temporarily pinned to its branch (kattni/beeware-docs-tools@tooling/zensical-migration), so this PR builds. The pin is reverted tobeeware/mainonce beeware/beeware-docs-tools#288 is merged.Changes
docs/config.ymlis nowdocs/zensical.toml, anddocs/mkdocs.en.ymlis nowdocs/zensical.en.toml. Both were generated by docs-tools'convert_mkdocs_config, which checked that the TOML configuration is equivalent to what Zensical read from the YAML.docs/en/SUMMARY.mdis replaced by the nativenavsetting indocs/zensical.toml, and the literate-nav plugin is removed.DISABLE_MKDOCS_2_WARNING/NO_MKDOCS_2_WARNINGenvironment variables, and the--source-code=stubsarguments; docs-tools now resolves the mkdocstringspaths(src,stubs) from the repository root.docs/_build.*.toml, the per-language configuration docs-tools writes during a build.beeware-docs-toolsin thedocsdependency group, as described above.There are no content changes to the documentation itself.
Verification
tox -r -e docs(installing docs-tools atb3a1e03from the pinned branch) builds in strict mode with no issues.tox -e docs-lintandtox -e pre-commitpass.main:navinstead ofSUMMARY.md.srcandstubsare identical, including members that only exist in the stubs (sofind_stubs_packageis honoured).objects.invis identical (234 entries), and links to the Python docs viainventoriesresolve the same.:::identifier, so the existingvalidationsettings still apply.Notes for reviewers
site_url: the converter moved the literalsite_urlintozensical.toml. As before, it takes precedence over the canonical URL from Read the Docs.pymdownx.magiclinksettings userepo = "toga". As a result,#40in the release notes links to a Toga issue, and@propertyintopics/memory-management.mdis rendered as a GitHub user link. This should probably berubicon-objc; I've left it for a separate change.po2mdcollapses the indentedoptions:blocks under:::directives, and the translated build fails. This happens under both MkDocs and Zensical, so it isn't a regression..specify/memory/constitution.mdstill says the docs are built with Sphinx. It's only meant to change through the SpecKit constitution workflow, so I didn't edit it.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)