Skip to content

Fix Sphinx docs build warnings#91

Merged
JE-Chen merged 2 commits intomainfrom
dev
Apr 27, 2026
Merged

Fix Sphinx docs build warnings#91
JE-Chen merged 2 commits intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

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

Summary

  • Set autosectionlabel_prefix_document = True so common section titles (Overview / Methods / Parameters / 概述) stop colliding across files — clears ~70 duplicate-label warnings.
  • Fix smart_wait.wait_for_spa_route_stable docstring: \`\`quiet_for\`\`s violated docutils' inline-literal close rule; escaped to \`\`quiet_for\`\`\ s.
  • Fix Zh extended_features_doc.rst:97: closing inline literal was directly followed by full-width — added \ separator.
  • Rename the second Observability heading in Eng extended_features_doc.rst to Observability tooling so two sections in the same file don't collide.
  • Add docs/build/ and the autosummary generated/ tree to .gitignore.

After these changes sphinx-build -W --keep-going succeeds with zero warnings, so RTD builds (and any future -W CI gate) won't fail.

Test plan

  • RTD build green on this branch
  • cd docs && python -m sphinx -b html -W --keep-going source build/html succeeds locally

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented Apr 27, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

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 a2fb0ae into main Apr 27, 2026
22 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