Conversation
Adopt WebRunner's docs layout: a single Sphinx project under docs/source/ with per-language subdirectories (Eng/, Zh-TW/, Zh-CN/) and a language-neutral API/ tree. The top-level index.rst is a slim hero with four toctrees pointing at chapter sub-indexes (eng_index, zh_tw_index, zh_cn_index, api_index); each sub-index has chapter sections that toctree to the chapter docs. Cross-language navigation now works through normal Sphinx toctrees inside the same build — relative ../html-zh-TW/ links and per- language RTD projects are no longer needed. Drop the per-language .readthedocs.zh-*.yaml files, drop the source.zh-TW/ and source.zh-CN/ source trees, drop the per-language conf.py + index, and simplify make.bat / Makefile to a single html target. Single API tree built once from English autodoc avoids the duplicate object descriptions warnings the three-tree layout produced.
Up to standards ✅🟢 Issues
|
|
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.



Summary
Cross-language navigation never worked on the public site because only the English source was deployed by RTD; the manual switcher links to
../html-zh-TW/were 404s. Adopt WebRunner's docs layout instead: one Sphinx project with language subdirectories. All three languages now build into a single deployment, and cross-language navigation goes through normal Sphinx toctrees inside the same project.New tree
What changed
docs/source/index.rst— slim WebRunner-style hero (title, tagline, PyPI / GitHub / License bullets, organisation paragraph) followed by four toctrees:English manual,繁體中文手冊,简体中文手册,API reference. Each toctree points at one chapter sub-index.Eng/eng_index.rst,Zh-TW/zh_tw_index.rst,Zh-CN/zh_cn_index.rst,API/api_index.rst. Each has a.. contents::directive plus chapter sections, each section toctree'ing to one chapter doc.architecture.rstis now per-language under each subdir.API/— translated API titles dropped, since the autodoc-generated content was identical across languages and was producing 28duplicate object descriptionwarnings.docs/source.zh-TW/,docs/source.zh-CN/,.readthedocs.zh-TW.yaml,.readthedocs.zh-CN.yaml, the per-languageconf.pyfiles, the per-languageindex.rstfiles, and thehtml-zh-TW/html-zh-CN/html-alltargets inmake.bat/Makefile.docs/source/conf.py— removedhtml_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")(single-project setup; canonical URL handling is no longer per-language).Commits in this PR
1e2c700Consolidate docs into one Sphinx project with language subdirectoriesTest plan
rm -rf docs/_build && py -m sphinx -b html docs/source docs/_build/html→build succeededwith no new toctree / autodoc-duplicate warnings (only the 8 pre-existing CJK punctuation warnings inside chapter docs remain).English manual,繁體中文手冊,简体中文手册,API reference.index.html: confirm it lands on the corresponding sub-index, and every chapter link opens a real page.https://fileautomation.readthedocs.io/en/latest/shows all four sections, with/Eng/...,/Zh-TW/...,/Zh-CN/...,/API/...all reachable.