📝 Make documentation executable and checked - #2462
Open
burgholzer wants to merge 1 commit into
Open
Conversation
12 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
burgholzer
force-pushed
the
docs/executable-documentation
branch
from
September 8, 2026 09:47
1a11215 to
7b55960
Compare
Correct DD mathematics and capability claims, execute local workflows, and validate fresh notebooks and generated navigation. Use the selected target payload contract and pin the merged template guidance. Assisted-by: Codex
burgholzer
force-pushed
the
docs/executable-documentation
branch
from
September 8, 2026 21:58
7b55960 to
1460704
Compare
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
A successful documentation build could reuse stale notebook results, accept
failed CLI commands, and publish broken navigation. Several DD equations and
public capability statements were also incorrect. This change addresses all
twelve groups in the documentation audit:
explanations, and compiler/Qiskit/calibration contracts.
isolate QDMI discovery, and fail on CLI or Doxygen errors.
and expose the C++ reference through the normal toctree and agent index.
results and accessible figures, and remove redundant configuration and assets.
The rendered installation, contribution, and tooling changes come from
Templates #438.
That change is merged, and the templating workflow pins its main commit
38a2369c8303887135af5e98d9e7003ed267b613. Existing Sphinx, MyST-NB, and native Doxygen tooling is retained;no dependency or library runtime change is introduced.
The changes have been reassessed and replayed on upstream main
0c3fac2cb.Executable target-compilation and DDSIM examples use
TargetEnvironmentandPayloadSpecification. The Qiskit reference preserves the merged custom-gate,scalar-folding, and snapshot contracts; merged OpenQASM, QIR, DDSIM, benchmark,
and generated-header lint updates are retained.
Validation: the full HTML build with Read the Docs' Doxygen 1.9.8 and generated
local links passed. All nine notebooks (56 code cells) executed without error or
stderr outputs. External linkcheck, full lint, and both navigation regression
tests passed.
The standard cpp-lint session excludes public headers and selected no files.
A separate full-header check reported five existing naming/conversion warnings
in
Client.hpp, reproduced against the original header; none concern the editedcomments. Generated figures and image alternatives were inspected; the browser
preview could not connect to localhost. Hosted CI and human review are pending.
No remote hardware or provider deployment was exercised.
Codex implemented and validated this change under explicit user authorization.
No changelog or migration entry is needed for these documentation and validation
changes.
Checklist
If PR contains AI-assisted content:
🤖 *AI text below* 🤖(titles are exempt).