Skip to content

Restore Task Program API navigation and symbol links - #803

Merged
yuecideng merged 1 commit into
mainfrom
codex/fix-task-program-api-links
Oct 17, 2026
Merged

yuecideng merged 1 commit into
mainfrom
codex/fix-task-program-api-links

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

Description

The task_program entry in the lab API's Submodules table renders as plain text because the Task Program API pages disable Sphinx index registration. Several child pages also render class/function summaries without links. Their HTML pages exist, but their Python-domain targets are missing.

Restore module and member targets across the seven Task Program API facade pages, explicitly document exported data/type aliases, and exclude manually documented members from automatic expansion. Shared implementation identities are registered once beside their public definitions with invisible Sphinx targets, preserving clickable re-exports without duplicate canonical registrations. Qualify two frontend exception references to remove ambiguity once the additional targets exist.

Follow-up to merged #802, based on a90838fff3e444619acd270c164b45f3468c1a98. No runtime logic, public API, dependency or configuration changes; the Python source edit changes two docstrings only.

Type of change

  • Bug fix
  • Documentation update

Validation

  • Reproduced the original missing parent link in a baseline Sphinx 7.4.7 HTML build, using the real SDK modules and the production autodoc/autosummary extensions.
  • The same focused build after the fix verifies 7 module targets, all 279 public export targets, and 1,500 summary links, including destination files/fragments and objects.inv entries.
  • Parent link now resolves to embodichain.lab.task_program.html#module-embodichain.lab.task_program.
  • Focused-build warnings decreased 16 → 11, with no new warnings. The remaining warnings are existing module-docstring formatting, a title underline, and unresolved forward type annotations. This validation builds the affected API pages, not the entire documentation site.
  • Public API coverage: 2602/2602 exports documented.
  • pytest tests/docs/test_check_api_docs.py -q --confcutdir=tests/docs: 9 passed.
  • black . with 26.3.1: 1301 files unchanged; git diff --check passes.
  • Executable AST comparison confirms the frontend source change contains only docstring edits.
  • Reviewed affected task-programs context: no update needed because API/runtime/ownership contracts are unchanged.

Screenshots

The baseline parent entry has no href. The fixed entry links to the module anchor above; generated HTML and object-inventory checks validate the corresponding symbol links.

Checklist

  • I have run black . with the pinned version.
  • I reviewed affected documentation and agent context; no context update was needed.
  • Public API documentation coverage passes.
  • The fix is verified by baseline/fixed Sphinx builds and actual HTML/inventory checks, plus the existing focused documentation tests.
  • Dependencies reviewed; no dependency changes are required.

@yuecideng yuecideng added bug Something isn't working docs Improvements or additions to documentation labels Oct 17, 2026
@greptile-apps

greptile-apps Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable defects were found.

Summary

Restores Sphinx navigation and symbol targets across seven Task Program API pages.

  • Task Program API pages link to their exported names.
  • MLLM error docs now point to the public exception name.

No actionable issues found. Review covered the diff, related exports, documentation settings, existing tests, and repository rules. No Sphinx build or tests were run during this review.

Reviews (1) · Last reviewed commit: "docs: restore Task Program API cross-ref..." · Reviewed by Greptile

@yuecideng
yuecideng merged commit 2297b55 into main Oct 17, 2026
8 of 9 checks passed
@yuecideng
yuecideng deleted the codex/fix-task-program-api-links branch October 17, 2026 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant