Repository navigation
test: run the Python quick start in CI - #224
Merged
gouyt13 merged 2 commits intoNov 8, 2026
Merged
Conversation
github-actions
Bot
added
the
release:maintenance
Docs-only changes selected only the documentation build, so an edit to docs/docs/quick_start.md that broke its Python blocks passed CI. Select the Linux source-install job for that page and run test_quick_start.py in its smoke tests.
This was referenced Nov 8, 2026
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
Adds
tests/python/test_quick_start.py, which readsdocs/docs/quick_start.md,extracts the ```python blocks in order and runs them in one shared namespace
against the installed package. The test reads the Markdown, so there is no second
copy of the example. It runs from a temporary working directory, and the save/load
block already uses
TemporaryDirectory, so no files are left behind.Closes #215
No API, saved-index format or dependency changes.
Testing
python -m pytest tests/python/test_quick_start.py -v: 1 passednprobeton_probein block 1 ofquick_start.mdmakes the test fail with a
TypeErrorthat names the block (reverted afterwards)ruff format --check tests/pythonandruff check tests/python: passgit diff --checkclean;git statusshows only the new test filebash scripts/check-python.sh: passed successfully.