Skip to content

docs(zh_CN): fix the three inconsistent-reference warnings in the zh build - #68

Merged
wenh06 merged 1 commit into
masterfrom
docs-zh-i18n-fix
Nov 4, 2026
Merged

wenh06 merged 1 commit into
masterfrom
docs-zh-i18n-fix

Conversation

@wenh06

@wenh06 wenh06 commented Nov 4, 2026

Copy link
Copy Markdown
Owner

Summary

Sphinx 9's stricter i18n reference check flags three zh translations:

  • the SCAFFOLD link in algorithms/overview.rst and the
    convergence-theorem link in algorithms/proximal.rst had their link
    texts translated; the raw reference form now matches the English
    originals (proper-noun link labels stay English);
  • the fl_sim.optimizers module docstring translation had dropped the
    two :mod: references (torch.optim, torch_optimizer); they are
    restored.

Validation

  • zh_CN docs build: zero warnings (was 3).
  • English build: unaffected.

…build

Sphinx 9's stricter i18n reference check flags zh translations whose
raw references differ from the English originals:

- the SCAFFOLD and convergence-theorem link texts in the algorithm
  theory pages keep the original English raw reference form
  (proper-noun link labels);
- the optimizers module docstring translation restores the two
  :mod: references (torch.optim, torch_optimizer) it had dropped.

The zh_CN build returns to zero warnings.
@wenh06
wenh06 merged commit 45924de into master Nov 4, 2026
28 checks passed
@wenh06
wenh06 deleted the docs-zh-i18n-fix branch November 4, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant