Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds Chinese translation support for the documentation and improves the changelog generation by standardizing the format.
- Adds comprehensive Chinese (Simplified) translations for all documentation pages
- Migrates changelog from ChangeLog.md to CHANGELOG.md following Keep a Changelog format
- Updates documentation build system to support multiple languages
- Adds new dependencies (myst-parser, sphinx-intl) for translation support
Reviewed Changes
Copilot reviewed 18 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds myst-parser and sphinx-intl dependencies for documentation translation support |
| docs/locale/zh_CN/LC_MESSAGES/*.po | Complete Chinese translations for installation, quickstart, user guide, contributing, changelog, API reference, and README documentation |
| docs/contributing.rst | Updates contributing guide with translation workflow and replaces pip commands with uv |
| docs/conf.py | Adds internationalization configuration including language support, locale directories, and language switcher |
| docs/changelog.rst | Simplifies to include CHANGELOG.md using myst-parser |
| docs/Makefile | Adds i18n build targets for generating translation files and building multi-language documentation |
| ChangeLog.md | Deletes old changelog file |
| CHANGELOG.md | Creates new standardized changelog following Keep a Changelog format |
| .github/workflows/docs.yml | Updates workflow to build all language versions of documentation |
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.
The parser reference 'myst_parser.sphinx_' is incorrect and has a trailing underscore. It should be 'myst_parser.sphinx_parser'.
Suggested change
| :parser: myst_parser.sphinx_ | |
| :parser: myst_parser.sphinx_parser |
Comment on lines
+94
to
+97
| "switcher": { | ||
| "json_url": "https://owenyou.github.io/dftt_timecode/_static/switcher.json", | ||
| "version_match": os.environ.get("READTHEDOCS_LANGUAGE", language), | ||
| }, |
There was a problem hiding this comment.
The module 'os' is used but not imported at the top of the configuration file. Add 'import os' to the imports.
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.