docs: add API reference pages for GridSpec and TimeAxis - #77
Merged
Conversation
GridSpec was entirely absent from the quartodoc reference nav -- docs/_quarto.yml's quartodoc sections and API Reference nav only ever listed cli.*/jobs.*/strategies.*/registry.*/cell_data.*/diagnostics.*/ sweep.*/jar.*. The preprocessing tutorial (docs/tutorials/preprocessing.qmd) is the only place GridSpec was documented at all, and it only narrates usage -- there was no reference page a reader could land on for the full method signatures (preprocess_geotiff/netcdf/csv, their _batch counterparts, from_yaml/save/describe/variant_sweep/etc.) or for TimeAxis. Adds a "Grid" nav section / "Grid Module" quartodoc section referencing grid.GridSpec and grid.TimeAxis, generating reference/grid.GridSpec.qmd and reference/grid.TimeAxis.qmd with all public methods and attributes documented from their existing docstrings -- no source changes needed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
GridSpec(andTimeAxis) were entirely absent from the API reference —docs/_quarto.yml's quartodocsectionsand nav only ever listedcli.*/jobs.*/strategies.*/registry.*/cell_data.*/diagnostics.*/sweep.*/jar.*. The preprocessing tutorial narrates usage, but there was no reference page to land on for the actual method signatures —preprocess_geotiff/preprocess_netcdf/preprocess_csv, their_batchcounterparts added in #75, orfrom_yaml/save/describe/variant_sweep/etc.grid.GridSpecandgrid.TimeAxis.Test plan
pixi run docs-build— rendersreference/grid.GridSpec.qmd(all 13 public methods, including bothpreprocess_*_batch()methods) andreference/grid.TimeAxis.qmddocs/objects.jsoninterlink diff: 34 entries added (joshpy.grid.GridSpec, its methods,joshpy.grid.TimeAxis, plus theirjoshpy.grid._core.*internal aliases), 0 removedpixi run -e dev pytest tests/ -m "not integration" -q— 1181 passed (no source touched)🤖 Generated with Claude Code