Repository navigation
📝 Fix API documentation markup and notebook builds - #1088
Merged
Merged
Conversation
Extracted from #1027; retain original authorship. Co-authored-by: Simon Hofmann <simon.t.hofmann@tum.de> Assisted-by: GPT-6 via Codex
simon1hofmann
added
documentation
11 of 12 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
simon1hofmann
force-pushed
the
codex/bench-documentation-fixes
branch
from
October 21, 2026 13:58
4b80544 to
1765826
Compare
simon1hofmann
added a commit
that referenced
this pull request
Oct 21, 2026
Use the same notebook build ordering as #1088 to prevent concurrent HTML and Markdown builds from deleting each other’s example output.
simon1hofmann
marked this pull request as ready for review
October 21, 2026 14:09
burgholzer
approved these changes
Oct 21, 2026
burgholzer
left a comment
burgholzer
left a comment
Member
There was a problem hiding this comment.
LGTM except for one small detail that is likely worth another look.
sphinx-llm 1.0 and 1.1 produce identical per-page Markdown. Version 1.1 exposes existing unsupported-node warnings; the cap does not restore missing content. Refs: NVIDIA/sphinx-llm#153
Signed-off-by: simon1hofmann <119581649+simon1hofmann@users.noreply.github.com>
simon1hofmann
added a commit
that referenced
this pull request
Oct 21, 2026
* 🐛 Preserve IonQ and Rigetti native gate semantics Extracted from #1027; retain original authorship. Co-authored-by: Simon Hofmann <simon.t.hofmann@tum.de> Assisted-by: GPT-6 via Codex * 📝 Reference #1086 in changelog * ✨ Add fractional Heron compilation targets Extracted from #1027; retain original authorship. Co-authored-by: Simon Hofmann <simon.t.hofmann@tum.de> Assisted-by: GPT-6 via Codex * 📝 Reference #1087 in changelog * ✅ Keep native regression tests in the target test module Cover bounded target aliases and legacy Qiskit serialization. Extract registry isolation from #1027. Remove the extra test file. Co-authored-by: Simon Hofmann <simon.t.hofmann@tum.de> * ✅ Keep fractional target tests in the existing test module Cover old Qiskit rejection and narrower caller-defined RZZ bounds. Co-authored-by: Simon Hofmann <simon.t.hofmann@tum.de> * 🐛 Preserve physical placements shared by native aliases Keep equivalent RX aliases on every supported physical site, including targets that also expose a standard X gate. Retain phase-correct local lowering and add mapped regressions. Assisted-by: GPT-6 via Codex * ✅ Check mixed aliases at native and mapped levels * 🐛 Serialize documentation builds that share notebook output Use the same notebook build ordering as #1088 to prevent concurrent HTML and Markdown builds from deleting each other’s example output. * Test minimum Qiskit support and complete mirror layouts * Test the fractional target compatibility error on current Qiskit * ♻️ Simplify fractional Heron registration and angle wrapping Use a shared packaging.version check while keeping Qiskit 2.1.2 support. Use theta parameters, simplify the local wrapping traversal and phase correction, and cover all optimization levels and large angles. Assisted-by: GPT-6 via Codex * ✅ Verify native gate constraints and restore minimums session Cover arbitrary U/RX compilation at all optimization levels for native and mapped targets, and check session equivalences remain unchanged. Keep local lowering because preset passes do not consistently enforce fixed R/RX angles. Restore noxfile.py to main. Assisted-by: GPT-6 via Codex * ⬆️ Require Qiskit 2.2.3 and simplify fractional targets Register fractional Heron targets unconditionally, remove obsolete compatibility guards and tests, and document the new Qiskit minimum and upgrade command. Assisted-by: GPT-6 via Codex --------- Co-authored-by: Lukas Burgholzer <burgholzer@me.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.
🤖 AI text below 🤖
Description
Fix Shor-code ket markup, benchmark error indentation, and configuration attribute documentation. Add heading anchors, expose generated version documentation, ignore private callable aliases as cross-reference targets, and serialize notebook-backed documentation generation.
Extracted from #1027 so this change can land independently of MQT Core 4.2. Original code authorship is retained.
Validation: Fresh HTML/Markdown builds passed with sphinx-llm 1.0 and 1.1; all 74 per-page Markdown files were byte-for-byte identical. Version 1.1 reports existing unsupported-node warnings (upstream #153). The final documentation build and all lint hooks passed. Type checking used Python 3.14.
GPT-6 via Codex assisted with extraction, tests, and this description.
Checklist
If PR contains AI-assisted content:
🤖 *AI text below* 🤖(titles are exempt).