Skip to content

Give each top-level doc its own toctree caption#72

Merged
JE-Chen merged 1 commit intomainfrom
dev
Apr 28, 2026
Merged

Give each top-level doc its own toctree caption#72
JE-Chen merged 1 commit intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

@JE-Chen JE-Chen commented Apr 28, 2026

Summary

  • Split the single Documentation toctree on each landing page into three captioned toctrees — Architecture, Usage guide, API reference — so the Sphinx sidebar renders them as distinct chapters instead of a flat group.
  • Mirrored across English (docs/source), 简体中文 (docs/source.zh-CN), and 繁體中文 (docs/source.zh-TW).
  • Inside the Usage guide chapter the existing five sub-captions (Getting started, Local & transfer, Servers & integrations, Reliability & events, Configuration & extension) continue to render as their own sections.

Test plan

  • sphinx-build -b html docs/source docs/_build/html exits 0
  • sphinx-build -b html docs/source.zh-CN docs/_build/html-zh-CN exits 0
  • sphinx-build -b html docs/source.zh-TW docs/_build/html-zh-TW exits 0
  • Rendered HTML grep confirms three top-level captions per language plus five usage sub-captions

Architecture, the usage guide, and the API reference now each have
their own captioned toctree on the landing page so the sidebar renders
them as distinct chapters instead of bundling them under one
'Documentation' caption.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@sonarqubecloud
Copy link
Copy Markdown

@JE-Chen JE-Chen merged commit 4186f6f into main Apr 28, 2026
10 checks passed
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