[DOC] Host a clickable dune2 example report suite - #82
Merged
Conversation
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
Publishes a live, self-contained example report suite alongside the docs so readers can explore the real HTML output interactively instead of only reading a description. Fulfils the "worked example report is planned for a future release" note that previously sat at the bottom of
reports.rst.Changes
docs/source/_static/demo/dune2/(new): the five realdune2_1_2026report pages — Summary, Stack, Grid, and two per-instrument pages (microcat 2941, aquadopp 9920) — copied from the test fixtures, preserving theinstrument/subdirectory so the header cross-links resolve. Each page is self-contained (all figures base64-embedded; the only external reference is the GitHub link in the footer). Sphinx copies_static/verbatim, so they publish at.../oceanarray/_static/demo/dune2/….docs/source/reports.rst: adds a "Live example" section near the top — a click-through thumbnail (opens the Summary page) plus direct links to all five pages — and removes the now-obsolete placeholder note.docs/Makefile: adds ademo-reporttarget that refreshes the hosted suite from the fixture reports (which the test suite regenerates), so the example can be kept current with one command..gitattributes: marksdocs/source/_static/demo/**asbinary(=-diff -merge -text) on top of the existinglinguist-generated, so git treats the demo reports as opaque blobs — no textual diff, no merge, no line-ending normalization — while still tracking them for Sphinx to serve. Golden fixtures keeplinguist-generatedonly (they stay diffable, since their masked images make diffs meaningful on rebaseline).Notes
The committed snapshot (~2.6 MB across five pages) will drift from the current output when report layout or figures change;
make demo-reportregenerates it. A future option is to generate it during the docs CI build instead of committing it, but that is deferred.Breaking changes
None — documentation and build tooling only.