Repository navigation
Restore Task Program API navigation and symbol links - #803
Merged
Merged
Conversation
[Low impact] The PR appears safe to merge; no actionable defects were found. SummaryRestores Sphinx navigation and symbol targets across seven Task Program API pages.
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 |
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.
Description
The
task_programentry 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
Validation
objects.inventries.embodichain.lab.task_program.html#module-embodichain.lab.task_program.pytest tests/docs/test_check_api_docs.py -q --confcutdir=tests/docs: 9 passed.black .with 26.3.1: 1301 files unchanged;git diff --checkpasses.task-programscontext: 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
black .with the pinned version.