Skip to content

add infrastructre for executable examples, add results to the web page - #115

Open
ev-br wants to merge 4 commits into
benchx-dev:mainfrom
ev-br:ci_exec_md
Open

ev-br wants to merge 4 commits into
benchx-dev:mainfrom
ev-br:ci_exec_md

Conversation

@ev-br

@ev-br ev-br commented Nov 14, 2026 •

Copy link
Copy Markdown
Collaborator

This is a companion to benchx-dev/benchx_examples#16, which lays the ground work for making examples from benchx_examples executable.

The end goal is: that the examples stay current, and are executed on CI. Moreover:

  • benchx_examples CI runs examples for PRs in the _examples repo against the released benchx.
  • benchx PRs run examples in benchx CI
  • the doc build runs examples and places them to the docs website under a new "examples" heading.

To build the new doc site locally, use

$ python tools/build_site.py ../benchx_examples  
$ python -m http.server -d site 
# now open http://0.0.0.0:8000/

which expects to find the examples checkout of benchx-dev/benchx_examples#16 at ../benchx_examples.

Once the example PR lands, I'll change this one to look at benchx_examples main not a PR branch.

To keep the diffs small, I only hooked up a single example for now.

The locally built page looks like this:

Screenshot from 2026-11-14 19-55-22

Of course, examples themselves might need a rewrite for readability, which I also did not do just yet (to keep the diff sizes under control).

@ev-br
ev-br marked this pull request as draft November 14, 2026 17:23
@ev-br ev-br changed the title WIP: add reusable workflows for CI add infrastructre for executable examples, add results to the web page Nov 14, 2026
@ev-br
ev-br marked this pull request as ready for review November 14, 2026 20:18

This branch has not been deployed

No deployments
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