docs: render code output in evaluation walkthrough with markdown-exec#190
Merged
docs: render code output in evaluation walkthrough with markdown-exec#190
Conversation
Add markdown-exec plugin so Python code blocks in the evaluation walkthrough execute during mkdocs build and display their output inline. Blocks share a session for state continuity, matching the mktestdocs memory=True behavior.
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
markdown-execplugin so Python code blocks in the evaluation walkthrough execute duringmkdocs buildand display their output inlineprint()output render as text; the DataFrame block usesto_markdown()for a native tableexec="on"blocksTest plan
uv run mkdocs buildsucceeds, rendered HTML shows code outputmake test-docspasses (mktestdocs skips exec blocks)