Skip to content

Run generated documentation examples in docs CI#340

Merged
ciaranra merged 3 commits into
devfrom
docs-ci-example-fixes
Jul 8, 2026
Merged

Run generated documentation examples in docs CI#340
ciaranra merged 3 commits into
devfrom
docs-ci-example-fixes

Conversation

@qciaran

@qciaran qciaran commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

This draft first wires docs CI to run the same generated documentation example test path developers use locally:

  • build docs dependencies with just python-ci-build-docs
  • run generated docs examples with just docs-test
  • keep mkdocs build after the executable docs check

The 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 like state_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-test passes locally:

237 passed, 10 skipped, 5 deselected, 2 warnings

@qciaran
qciaran requested a review from ciaranra as a code owner July 7, 2026 20:53
@qciaran
qciaran marked this pull request as draft July 7, 2026 20:53
@ciaranra
ciaranra marked this pull request as ready for review July 7, 2026 23:11
@ciaranra
ciaranra merged commit 84c3090 into dev Jul 8, 2026
62 checks passed
@ciaranra
ciaranra deleted the docs-ci-example-fixes branch July 8, 2026 01:26
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.

2 participants