Skip to content

DOC: xradar-first user guide, API reference, and gallery examples - #1876

Open
mgrover1 wants to merge 1 commit into
ARM-DOE:mainfrom
mgrover1:pr/xradar-docs
Open

DOC: xradar-first user guide, API reference, and gallery examples#1876
mgrover1 wants to merge 1 commit into
ARM-DOE:mainfrom
mgrover1:pr/xradar-docs

Conversation

@mgrover1

Copy link
Copy Markdown
Collaborator

Closes #1778 (docs restructure for the xradar-first IO path). Best merged after #1873, whose features it documents.

  • New doc/source/userguide/xradar_integration.rst: which IO path to use today, a supported-API table for Xradar/Xgrid with caveats, and the reader-migration direction from roadmap Moderate-Priority I am testing a pull request from a user to a repo #1; pyart_2_0.rst and overview.rst deduplicated/updated; toctree wired.
  • pyart.xradar added to the API reference (doc/source/API/index.rst) with an autosummary-ready module docstring.
  • Gallery: the three existing examples/xradar/ scripts updated (radar.info, masked-array notes); new plot_rhi_xradar.py demonstrating RHI end to end (synthetic data, labeled as such).

Validation: every code snippet and example executed locally (all exit 0); docutils structural check clean; full sphinx-gallery build left to the docs CI job.

@mgrover1
mgrover1 requested a review from zssherman as a code owner July 23, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Restructure Py-ART Docs with 2.0 Release

1 participant