Repository navigation
Conversation
The 2024 copy was identical to the 2023 post, and made the post link to itself as the next post.
- Split the team details out of .authors.yml into .team.yml, so .authors.yml only has the fields the blog uses. The macros merge the two. - Read team bios and post metadata from the docs directory, since Zensical doesn't give macros the page files or navigation. - Use dict access for event details, and accept dates as strings or dates. - Emit Font Awesome icons as emoji shortcodes, and keep them text-sized. - Use docs-relative absolute links instead of autoref reference links, which leave placeholders in the RSS feed.
- Convert the MkDocs configs to Zensical TOML (zensical.toml, plus one file per language). - Build docs-redirect with Zensical, which handles redirects natively. - Pin beeware-docs-tools to the Zensical migration branch (temporary). - Drop the MkDocs 2 warning env vars and the mkdocs-redirects dependency.
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.
This PR moves the website and the docs.beeware.org redirect site from MkDocs to Zensical 0.1.0.
This depends on beeware/beeware-docs-tools#288. Until that PR merges,
pyproject.tomlpinsbeeware-docs-toolsto its branch (kattni/beeware-docs-tools@tooling/zensical-migration), with a TEMPORARY comment. Once beeware/beeware-docs-tools#288 merges, the pin goes back tobeeware/main.Configuration
docs/config.ymlanddocs/mkdocs.<lang>.yml) were converted with docs-tools'convert_mkdocs_config. The result isdocs/zensical.tomlplus onedocs/zensical.<lang>.tomlper language. docs-tools merges them at build time intodocs/_build.<lang>.toml, which is gitignored.tox.inino longer sets the MkDocs 2 warning env vars.Macros and content
Zensical reimplements mkdocs-macros, but macros no longer get the page's files or the navigation, and each page gets a fresh environment.
news/.authors.ymlinto a newnews/.team.yml, so.authors.ymlonly holds the fields the blog uses.macros.pymerges the two files.generate_team_members()no longer takespage, andlatest_news()andupcoming_events()take no arguments.fa()returns Font Awesome emoji shortcodes. A CSS override keeps the icons the same size as the text, as they were before./about/team.md#kattni). Autorefs links put<!-- zensical:autoref:N -->placeholders in the RSS feed instead of the link text. The links on the pages work the same.news/posts/2024/events/pycon-us-2023.md. It was identical to the 2023 post, and its "next post" link pointed at itself.docs-redirect
redirect_mapsnatively.mkdocs-redirectsis no longer needed.docs-redirect/mkdocs.ymlis replaced bydocs-redirect/zensical.toml.docs-redirectdependency group (justzensical). Theredirectsgroup is gone.index.htmlis byte-identical to the MkDocs build's. The 404 page is unchanged.Verification
tox -e docs-enandtox -e docs-depass in strict mode, with docs-tools atb3a1e03. No pages have macro errors.docs-redirectbuild passes in strict mode, using a fresh venv set up the way its RTD config does it.hide: navigationmatch, and RTL rendering works inar.<image><url>None</url>element is gone.tox -e pre-commitpasses.Weblate
Lock Weblate and sync it before merging this. This PR doesn't edit any
translations.pofile directly. However, it changes translatable English strings: thegenerate_team_members(...)lines inabout/team.md, plusindex.md. So the next translation update will rewrite everytranslations.po.Notes for reviewers
[tool.rumdl] flavor = "mkdocs"is unchanged. It sets the Markdown dialect for the linter, not the build tool.# image = ...), as it was in the MkDocs config. Zensical leaves out the<image>element, where MkDocs used to emit a broken one.PR Checklist:
Assisted-by: Claude Code (Claude Opus 5.5)