docs: surface vertical API in reference#653
Merged
Merged
Conversation
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.<Class>` path used for ComparerPlotter. User-guide coverage of the vertical workflow is tracked separately in #645.
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
1 participant
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
VerticalObservation,VerticalModelResult,VerticalAccessor,VerticalPlotter,SkillProfile, andSkillProfileArrayto the quartodoc sections and sidebar so the existing functionality has generated reference pages.VerticalAccessorandVerticalPlotterfrommodelskill.comparisonso quartodoc resolves them by the samecomparison.<Class>path used forComparerPlotter.`modelskill.VerticalObservation`cross-reference warning emitted byquarto renderforapi/obs.qmd,api/observation.qmd, andapi/DfsuModelResult.qmd.User-guide coverage of the vertical workflow is tracked separately in #645.
Test plan
just docscompletes without "Found no matches" warningsapi/VerticalObservation.html,api/VerticalModelResult.html,api/comparison.VerticalAccessor.html,api/comparison.VerticalPlotter.html,api/skill_profile.SkillProfile.html,api/skill_profile.SkillProfileArray.htmlComparerpage listsverticalaccessor