Repository navigation
Conversation
ev-br
force-pushed
the
ci_exec_md
branch
2 times, most recently
from
November 14, 2026 16:40
74f7a5a to
7c5b666
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.
closes gh-14
Make the examples' README files executable. The end goal is to satisfy:
For running on CI, there will be two runs:
benchxfrom pypi;benchxrepository, the same README executes on CI for eachbenchxPR using the main branch ofbenchx_examplesThis PR starts the process from the
pyperf-suiteexample (which actually already drifted): it adds a CI workflow to executeexamples/pyperf-suire/README.md. Two sets of moving parts:benchxCI with minimal duplication;jupytextwith MYST-markdown, but for now I'm using a simpler tech:markdown-it-pyto parse executable blocks from a markdown file + an ad-hoc script to parse it with the following rules for markdown fences:executes a shell command.
executes python code
is an example output. The first text fence which follows a
sh,bashorpythonfence is replaced by the actual output; other fences or unfenced triple backticks are preserved as is:While I'm not loving a 300-odd LOC python script for parsing markdown, it seems simple enough to not use a blunt general-purpose tool that MYST-markdown is. If it runs out of steam going forward, reusing MYST is easy enough.
FWIW, what I like of the current DIY solution is that it's easy to keep things readable in terminal (Myst-markdown is geared towards full-fledged jupyter notebooks and strips all output)