Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Generated report HTML: collapse in diffs, exclude from GitHub language stats.
# Generated report HTML: exclude both from GitHub language stats and collapse in
# PR diffs (linguist-generated). Golden fixtures stay diffable — their images are
# masked, so text/structure diffs are meaningful on rebaseline. The hosted demo
# reports are pure display artifacts: `binary` (= -diff -merge -text) treats them
# as opaque blobs — no textual diff, no merge, no line-ending normalization. Both
# remain tracked/committed (the demo suite is served from _static by Sphinx).
tests/fixtures/golden/** linguist-generated=true
docs/source/_static/demo/** linguist-generated=true
docs/source/_static/demo/** linguist-generated=true binary
12 changes: 11 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,17 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
.PHONY: help Makefile demo-report

# Refresh the hosted example report suite under source/_static/demo/dune2/ from
# the dune2_1_2026 fixture reports. Those fixtures are regenerated by the test
# suite (tests/unit/test_report_golden.py); run pytest first if they are stale.
demo-report:
rm -rf source/_static/demo/dune2
mkdir -p source/_static/demo/dune2/instrument
cp ../tests/fixtures/proc/dune2_1_2026/report/*.html source/_static/demo/dune2/
cp ../tests/fixtures/proc/dune2_1_2026/report/instrument/*.html \
source/_static/demo/dune2/instrument/

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
684 changes: 684 additions & 0 deletions docs/source/_static/demo/dune2/dune2_1_2026_grid_report.html

Large diffs are not rendered by default.

1,600 changes: 1,600 additions & 0 deletions docs/source/_static/demo/dune2/dune2_1_2026_report.html

Large diffs are not rendered by default.

1,217 changes: 1,217 additions & 0 deletions docs/source/_static/demo/dune2/dune2_1_2026_stack_report.html

Large diffs are not rendered by default.

1,084 changes: 1,084 additions & 0 deletions docs/source/_static/demo/dune2/instrument/dune2_1_2026_2941_report.html

Large diffs are not rendered by default.

1,827 changes: 1,827 additions & 0 deletions docs/source/_static/demo/dune2/instrument/dune2_1_2026_9920_report.html

Large diffs are not rendered by default.

35 changes: 26 additions & 9 deletions docs/source/reports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@ Or generate all reports in one go with ``oceanarray run`` (see :doc:`cli_referen

----

Live example
------------

The report suite below was generated from the ``dune2_1_2026`` test mooring and
is hosted alongside these docs so you can explore the real output interactively.

.. figure:: /_static/oceanarray_report_header.png
:target: _static/demo/dune2/dune2_1_2026_report.html
:align: center
:alt: Live dune2_1_2026 Summary report — click to open

**Click to open the live** ``dune2_1_2026`` **example report.** It opens the
Summary page; the header pills link through to the Stack, Grid, and
per-instrument pages. Every figure is embedded in the page — no web server,
downloads, or extra assets needed.

Direct links to each page:

- `Summary <_static/demo/dune2/dune2_1_2026_report.html>`__
- `Stack <_static/demo/dune2/dune2_1_2026_stack_report.html>`__
- `Grid <_static/demo/dune2/dune2_1_2026_grid_report.html>`__
- `Instrument — microcat 2941 <_static/demo/dune2/instrument/dune2_1_2026_2941_report.html>`__
- `Instrument — aquadopp 9920 <_static/demo/dune2/instrument/dune2_1_2026_9920_report.html>`__

----

Report pages
------------

Expand Down Expand Up @@ -205,12 +231,3 @@ by a colour-coded pill:

Stack and Grid pills are grey for any instrument that did not reach Stage 3
(only Stage 3 output is included in the stack).

----

.. note::

A complete worked example report is planned for a future release. Once an
example mooring dataset is available, the full HTML report will be hosted
alongside this documentation so that the layout and sections can be explored
interactively.
Loading