Run generated documentation examples in docs CI#340
Merged
Conversation
qciaran
marked this pull request as draft
July 7, 2026 20:53
ciaranra
marked this pull request as ready for review
July 7, 2026 23:11
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
This draft first wires docs CI to run the same generated documentation example test path developers use locally:
just python-ci-build-docsjust docs-testmkdocs buildafter the executable docs checkThe first commit intentionally does not fix the examples yet, so CI should expose the currently hidden failures in generated docs tests.
Expected failures
Locally, enabling this catches stale/broken examples in:
docs/user-guide/simulators.md: examples use legacy simulator classes in.quantum(...)instead of current builder functions likestate_vector(),sparse_stab(), etc.docs/user-guide/qec-guppy.md: the color-code runtime example stalls in HUGR execution.Follow-up
I have local fixes prepared for the docs examples. With those fixes applied,
just docs-testpasses locally:237 passed, 10 skipped, 5 deselected, 2 warnings