From 7b3f3cd59e0adbb92a63187b1357d91d898b4153 Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Mon, 18 May 2026 16:09:52 +0200 Subject: [PATCH] docs: surface vertical API in reference Add VerticalObservation, VerticalModelResult, VerticalAccessor, VerticalPlotter, SkillProfile, and SkillProfileArray to the quartodoc sections and sidebar so the existing functionality has generated reference pages. Resolves the dangling `modelskill.VerticalObservation` cross-reference warning in api/obs.qmd, api/observation.qmd, and api/DfsuModelResult.qmd. Re-export VerticalAccessor and VerticalPlotter from modelskill.comparison so quartodoc can resolve them by the same `comparison.` path used for ComparerPlotter. User-guide coverage of the vertical workflow is tracked separately in #645. --- docs/_quarto.yml | 21 +++++++++++++++++++-- src/modelskill/comparison/__init__.py | 3 +++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/_quarto.yml b/docs/_quarto.yml index 7ed22d01e..4c3e92d85 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -83,6 +83,7 @@ website: - api/TrackObservation.qmd - api/NodeObservation.qmd - api/ReachObservation.qmd + - api/VerticalObservation.qmd - section: "Model Result" href: api/model.qmd contents: @@ -93,6 +94,7 @@ website: - api/GridModelResult.qmd - api/DummyModelResult.qmd - api/NetworkModelResult.qmd + - api/VerticalModelResult.qmd - section: "Matching" contents: - api/match.qmd @@ -106,9 +108,13 @@ website: href: api/comparison.ComparerPlotter.qmd - api/ComparerCollection.qmd - text: "ComparerCollectionPlotter" - href: api/comparison.ComparerCollectionPlotter.qmd + href: api/comparison.ComparerCollectionPlotter.qmd + - text: "VerticalAccessor" + href: api/comparison.VerticalAccessor.qmd + - text: "VerticalPlotter" + href: api/comparison.VerticalPlotter.qmd - section: "Skill" - contents: + contents: - api/SkillTable.qmd - text: "SkillArray" href: api/skill.SkillArray.qmd @@ -118,6 +124,10 @@ website: href: api/skill_grid.SkillGrid.qmd - text: "SkillGridArray" href: api/skill_grid.SkillGridArray.qmd + - text: "SkillProfile" + href: api/skill_profile.SkillProfile.qmd + - text: "SkillProfileArray" + href: api/skill_profile.SkillProfileArray.qmd - text: "Plotting" href: api/plotting.qmd contents: @@ -172,6 +182,7 @@ quartodoc: - TrackObservation - NodeObservation - ReachObservation + - VerticalObservation - title: Model Result desc: "" contents: @@ -184,6 +195,7 @@ quartodoc: - GridModelResult - DummyModelResult - NetworkModelResult + - VerticalModelResult - title: Matching desc: Matching functions contents: @@ -198,6 +210,7 @@ quartodoc: - name: Comparer members: - plot + - vertical - skill - gridded_skill - score @@ -228,6 +241,8 @@ quartodoc: - save - load - name: comparison.ComparerCollectionPlotter + - name: comparison.VerticalAccessor + - name: comparison.VerticalPlotter - title: Skill desc: "" @@ -237,6 +252,8 @@ quartodoc: - name: skill.SkillArrayPlotter - name: skill_grid.SkillGrid - name: skill_grid.SkillGridArray + - name: skill_profile.SkillProfile + - name: skill_profile.SkillProfileArray - title: Plotting desc: "" diff --git a/src/modelskill/comparison/__init__.py b/src/modelskill/comparison/__init__.py index 1936f3925..653440e24 100644 --- a/src/modelskill/comparison/__init__.py +++ b/src/modelskill/comparison/__init__.py @@ -8,6 +8,7 @@ from ._collection import ComparerCollection from ._comparer_plotter import ComparerPlotter from ._collection_plotter import ComparerCollectionPlotter +from ._vertical_comparison import VerticalAccessor, VerticalPlotter __all__ = [ @@ -15,4 +16,6 @@ "ComparerCollection", "ComparerPlotter", "ComparerCollectionPlotter", + "VerticalAccessor", + "VerticalPlotter", ]