Skip to content

docs: render code output in evaluation walkthrough with markdown-exec#190

Merged
knutdrand merged 1 commit intomasterfrom
docs/clim-481-markdown-exec
Feb 6, 2026
Merged

docs: render code output in evaluation walkthrough with markdown-exec#190
knutdrand merged 1 commit intomasterfrom
docs/clim-481-markdown-exec

Conversation

@knutdrand
Copy link
Collaborator

Summary

  • Add markdown-exec plugin so Python code blocks in the evaluation walkthrough execute during mkdocs build and display their output inline
  • Blocks with print() output render as text; the DataFrame block uses to_markdown() for a native table
  • Update CLAUDE.md and writing_building_documentation.md with guidelines for exec="on" blocks

Test plan

  • uv run mkdocs build succeeds, rendered HTML shows code output
  • make test-docs passes (mktestdocs skips exec blocks)

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.
@knutdrand knutdrand merged commit 8642c47 into master Feb 6, 2026
6 checks passed
@knutdrand knutdrand deleted the docs/clim-481-markdown-exec branch February 6, 2026 10:42
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.

1 participant

Comments