Conversation
…evelopment workflow
The language-switcher.html template and switcher.json were missing from the previous commit because they were ignored by docs/.gitignore. Changes: - Remove _static/ and _templates/ from docs/.gitignore - Add docs/_templates/language-switcher.html (custom navbar component) - Add docs/_static/switcher.json (language switcher configuration) This fixes the GitHub Actions build error: "'language-switcher.html' not found" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds Chinese (Simplified) translation support for the documentation and improves the changelog structure by migrating to a standardized markdown format.
Key changes:
- Complete Chinese translation coverage for all documentation sections (user guide, quickstart, installation, API reference, contributing guide, and changelog)
- Migration from
ChangeLog.mdto standardizedCHANGELOG.mdfollowing Keep a Changelog format - Integration of Sphinx i18n/gettext infrastructure with language switcher UI component
Reviewed Changes
Copilot reviewed 21 out of 32 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Added i18n dependencies (myst-parser, sphinx-intl) |
| docs/locale/zh_CN/LC_MESSAGES/*.po | Chinese translation catalogs for all documentation pages |
| docs/conf.py | Configured Sphinx i18n settings and language switcher |
| docs/changelog.rst | Refactored to include CHANGELOG.md via myst-parser |
| docs/contributing.rst | Updated to document translation workflow and use uv commands |
| docs/Makefile | Added i18n build targets (gettext, update-po, html-all, html-zh) |
| docs/_templates/language-switcher.html | Language switcher dropdown component |
| docs/_static/switcher.json | Language versions configuration |
| CHANGELOG.md | New standardized changelog replacing ChangeLog.md |
| .github/workflows/docs.yml | Updated to build all language versions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - Extended validation and error handling | ||
| - Additional utility functions for common workflows | ||
| .. include:: ../CHANGELOG.md | ||
| :parser: myst_parser.sphinx_ |
There was a problem hiding this comment.
Corrected parser reference from 'myst_parser.sphinx_' to 'myst_parser.sphinx_parser'.
Suggested change
| :parser: myst_parser.sphinx_ | |
| :parser: myst_parser.sphinx_parser |
| #: ../../../CHANGELOG.md:152 | ||
| #, fuzzy | ||
| msgid "Changed" | ||
| msgstr "更新日志" |
There was a problem hiding this comment.
The translation 'msgstr' for 'Changed' is incorrectly set to '更新日志' (which means 'Changelog'). The correct translation should be '变更' or '修改'. This error will cause the 'Changed' section header to display as 'Changelog' in Chinese.
Suggested change
| msgstr "更新日志" | |
| msgstr "变更" |
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.
No description provided.