Document xarray ERDDAP backend (Sphinx + README)#447
Open
Divyateja2709 wants to merge 3 commits intoioos:mainfrom
Open
Document xarray ERDDAP backend (Sphinx + README)#447Divyateja2709 wants to merge 3 commits intoioos:mainfrom
Divyateja2709 wants to merge 3 commits intoioos:mainfrom
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
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.
This PR adds user-facing documentation for the xarray engine="erddap" backend to improve discoverability and usability.
Changes
Added a new Sphinx page (docs/source/xarray.rst) describing:
Purpose of the backend
Dependencies
Quick start usage
API reference via automodule (erddapy.xarray_erddap)
Linked the new page in the documentation toctree (index.rst)
Updated README.md with:
Installation instructions (erddapy, xarray, netcdf4)
Minimal working example using xr.open_dataset(..., engine="erddap")
Link to hosted documentation
GSoC alignment (ioos/gsoc#108)
This directly addresses the goal of “Major functionality documented” for the erddapy xarray plugin by:
Providing structured Sphinx documentation aligned with existing docs
Adding a quick-start entry point in the README for new users
Why this matters
Makes the xarray backend easier to discover and use
Reduces onboarding friction for new users
Aligns documentation with existing ERDDAP usage patterns
Complements ongoing work on tests and CI coverage
Notes
Expected docs URL after deploy: https://ioos.github.io/erddapy/xarray.html
This branch is based on tests and includes recent xarray/GridDAP test work
Independent of the CI coverage artifacts PR (ci/coverage-artifacts)