docs(zh): join CJK line wraps in rst_source - #214
mintonight wants to merge 5 commits into
Conversation
Sphinx inserts a space at RST line breaks. On Chinese pages that split compounds such as 动作原语 and 近距离. Join CJK-to-CJK wraps under docs/source-zh/rst_source. Also drop the extra 首版 claim on the flywheel page and use the English libero-data-flywheel label.
Documentation build overview
19 files changed ·
|
wilburx813
left a comment
wilburx813
left a comment
There was a problem hiding this comment.
Thanks for the contribution! Is this format problem only appers in chinese docs?
是的，目前只在中文文档中发现这些问题 |
qurakchin
left a comment
qurakchin
left a comment
There was a problem hiding this comment.
Thanks for the contribution!
There are 2 points to deal with:
- Could you please use some method such as suffix to collapse the overlong lines? The max width now is 262 in one line.
- Please check the whole pr. Some fixes may lost after rebase.
Sphinx joins a normal RST newline with a space, so Chinese prose cannot stay hard-wrapped as plain lines. Break those lines near 80 columns with a trailing backslash. Docutils drops the backslash and the newline, and the published text stays continuous. After the merge from main, the RoboCasa and RoboTwin explore sections still had CJK-to-CJK wraps, and add_primitive had one more. Those joins now use the same continuation. The previous 262-character line in robotwin.rst is gone. Code blocks, directives, and unsplittable URLs are unchanged.
|
Addressed both points.
Rendered text is otherwise unchanged, including the flywheel wording. |
The Chinese docs build treats Sphinx warnings as errors. A wrapped list item continued with a tab, which docutils reports as unexpected indentation. Keep that continuation at the same indent as the list item.
3 participants
Description
Sphinx joins wrapped RST lines with a space. On Chinese pages that
splits compounds in the published HTML (for example 动作 原语, 近距 离,
一条 轨迹).
This PR only joins CJK-to-CJK wraps under
docs/source-zh/rst_source/(19 files, 409 wraps). List items, code blocks, and Latin-token
boundaries are unchanged.
Also on the flywheel page: drop the extra 首版 claim (English is
evaluation-only, not first version) and use the same
libero-data-flywheellabel as the English page.Jev 1.13 sampled 24 wraps across usage, development, overview,
installation, quickstart, and awesome_works; all scored noul ≥ 0.71
as unwanted spaces.
Testing
docs/source-zh/rst_source/**/*.rst: 0 remainingCJK-to-CJK paragraph wraps.
Manual verification
Not needed. Confirm Chinese HTML no longer inserts a space between
CJK characters at the old wrap points.
Checklist