Skip to content

docs: link each capability-matrix search to its autofit_inference catalogue card - #1696

Merged
Jammy2211 merged 2 commits into
mainfrom
feature/search-ext-a5-capmatrix-cards
Oct 15, 2026
Merged

Jammy2211 merged 2 commits into
mainfrom
feature/search-ext-a5-capmatrix-cards

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

The capability matrix (docs/searches/index.rst) gets a Catalogue column. Each manifest search now links to its card in the autofit_inference benchmark catalogue. A search without a card reads "no catalogue card yet".

  • docs/_generate_searches.py fetches catalogue/search_catalogue.json by raw URL at the pinned CATALOGUE_COMMIT = bea1d8746cf009ff414ea0786c92f3e3e0909f70 (autofit_inference main, 2026-10-15). Nothing is vendored except the generated .rst.
  • Cards are keyed by search name (tasks.<task>.searches.<Name>). Each cell links the task label to the GitHub blob of the catalogue at the pinned sha, with a #L<line> anchor on that card and its status (measured / deferred / unsupported). All 15 anchors were checked against the file at the pin.
  • The pin is recorded twice: in an RST comment at the top of the generated page, and in the column note.
  • Offline (no connection), the matrix is skipped with a stderr message that names it, and the other two pages are still written (exit 1) or checked (exit 0). An HTTP error (a bad or unpushed pin) or an unreadable catalogue is always an error. The Docs workflow's generated-search-docs job runs --check --require-catalogue, so CI never skips.
  • Pages board: autofit_inference has no GitHub Pages site (gh api .../pages returns 404, and its README names none). The PyAutoInsight board (https://pyautolabs.github.io/PyAutoInsight/) has no per-search anchors. So the cards link to the catalogue JSON at the pinned commit, and the page points readers to the Insight board.
  • New test test_autofit/test_generate_searches_catalogue.py uses a fixture catalogue and no network. It covers a present card, an absent card, line anchors (with a decoy searches block), the pin recorded in the page, unreadable JSON, HTTP 404 as an error, the offline --check skip and --require-catalogue.

Test Plan

  • python docs/_generate_searches.py --check --require-catalogue reports "3 generated search pages are up to date". docs/api/searches.rst and docs/searches/citations.rst were regenerated with no change.
  • pytest test_autofit/test_generate_searches_catalogue.py test_autofit/test_generated_search_docs.py: 8 passed.
  • Full pytest test_autofit (first commit): 3817 passed, 1 skipped.
  • Sphinx: python -m sphinx -b html docs ... -w warnings.log, the same command as Heart's docs-build workflow. Branch: 30 warnings. Main (7f36e16): 30 warnings. Baseline: 30. The warning sets are identical apart from the build path, and none are in searches/index. After review, only one sentence of prose in the column note changed (no new markup); the Docs CI leg re-checks this.

Validation checklist (--auto run — plan was not pre-approved)

  • Effective level: safe (header: safe, cap: docs → safe); Consequence: glance
  • Plan: on the issue (docs: link each capability-matrix search row to its autofit_inference catalogue card #1694), written at start, unmodified since
  • Gate: tests 8/8 targeted + 3817 passed / 1 skipped full suite · smoke n-a (docs generator + generated .rst only; no library code path changes) · review: one independent Opus round returned FINDINGS (1 medium, 2 low, 1 nit). The medium (HTTP 404 silently skipped under --check), the board-wording low and the nit are fixed in f815746. The low on the unbounded forward key scan is not fixed: the anchors are correct at the pin, the decoy case is tested and a missed anchor degrades to a plain file link · Heart RED under the development-only override below
  • Witness: every manifest search gets a card link or "no catalogue card yet" in docs/searches/index.rst at a pinned commit ✔ · Sphinx shows no new warnings (30 = 30 = baseline) ✔ · generated files regenerated in the PR ✔
  • Human: plan sound in hindsight?
  • Human: diff matches plan (no scope creep)?
  • Human: merge, amend, or reject — then log the outcome

Heart RED — development-only override (quoted from #1694)

Heart at the door: Heart: RED — Release RED; monitoring RED · 10/100 · 415 unresolved; [red] release validation FAILED (stage integrate); … Live human in session 6ffb59e9 answered AskUserQuestion "Yes, override for development (Recommended)" on 2026-10-15 for this launch. Permitted: commit, push, PR-open. Merge is a separate human act; this never reaches a release.

Tier: glance — ends at PR-open under the Heart RED override

pending-release: the generated docs ship with the next PyAutoFit release.

Closes #1694

🤖 Generated with Claude Code

Jammy2211 and others added 2 commits October 15, 2026 19:05
…alogue card

docs/_generate_searches.py now fetches autofit_inference
catalogue/search_catalogue.json by raw URL at a pinned commit
(CATALOGUE_COMMIT = bea1d8746cf0) and adds a Catalogue column to the
capability matrix: each search links to its card (tasks.<task>.searches.<name>)
at that commit with a line anchor, or reads "no catalogue card yet". The pin is
recorded in a comment and the column note of docs/searches/index.rst. Offline,
the matrix is skipped with a named stderr message and the other pages are still
written or checked.

Closes #1694

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
An HTTP error (bad or unpushed pin) or an unreadable catalogue is now an error
(CatalogueError), never a skip; only a connection failure skips the matrix, and
--require-catalogue (used by the generated-search-docs job) makes that an error
too. Parse the catalogue once; reword the board note (the benchmark records feed
the PyAutoInsight board). Test the 404 path.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Oct 15, 2026
@Jammy2211
Jammy2211 merged commit d02cb91 into main Oct 15, 2026
5 checks passed
@Jammy2211
Jammy2211 deleted the feature/search-ext-a5-capmatrix-cards branch October 15, 2026 19:03
@Jammy2211 Jammy2211 removed the pending-release PR queued for the next release build label Oct 16, 2026
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.

docs: link each capability-matrix search row to its autofit_inference catalogue card

1 participant