intel / p3-analysis-library

A library simplifying the collection and interpretation of P3 data.
https://intel.github.io/p3-analysis-library/
MIT License
7 stars 10 forks source link

Add a new workflow to test the gallery #57

Closed Pennycook closed 3 weeks ago

Pennycook commented 1 month ago

This workflow tests that examples and case studies in the gallery execute correctly, and saves any plots produced as artifacts for visual inspection.

It does not test that the documentation builds correctly with Sphinx.

Related issues

Closes #37.

Proposed changes

There's nothing in this PR that makes any attempt to check that the PNGs are correct, because I think the only way to do that is going to be via visual inspection. But the validation will fail if no PNGs are produced.

It may be possible to improve on this further by uploading a separate artifact for each output graph, but I couldn't figure out how to do this with my limited experience of GitHub actions.

I tested this on my own fork, and you can see an example output here.