Repository navigation
docs: link each capability-matrix search to its autofit_inference catalogue card - #1696
Merged
Merged
Conversation
…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>
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.
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.pyfetchescatalogue/search_catalogue.jsonby raw URL at the pinnedCATALOGUE_COMMIT = bea1d8746cf009ff414ea0786c92f3e3e0909f70(autofit_inferencemain, 2026-10-15). Nothing is vendored except the generated .rst.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.generated-search-docsjob runs--check --require-catalogue, so CI never skips.gh api .../pagesreturns 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.test_autofit/test_generate_searches_catalogue.pyuses a fixture catalogue and no network. It covers a present card, an absent card, line anchors (with a decoysearchesblock), the pin recorded in the page, unreadable JSON, HTTP 404 as an error, the offline--checkskip and--require-catalogue.Test Plan
python docs/_generate_searches.py --check --require-cataloguereports "3 generated search pages are up to date".docs/api/searches.rstanddocs/searches/citations.rstwere regenerated with no change.pytest test_autofit/test_generate_searches_catalogue.py test_autofit/test_generated_search_docs.py: 8 passed.pytest test_autofit(first commit): 3817 passed, 1 skipped.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 insearches/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)
--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 belowdocs/searches/index.rstat a pinned commit ✔ · Sphinx shows no new warnings (30 = 30 = baseline) ✔ · generated files regenerated in the PR ✔Heart RED — development-only override (quoted from #1694)
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