Update API documentation

[djhoese]

This PR adopts the same API strategy as Satpy. It also fixes various reference warnings/issues.

Note: I have not run sphinx in nitpicky mode to look at every reference issue. I'm not sure I'm ready to go down that rabbit hole yet.

• Closes #xxxx
• Tests added
• Tests passed
• Fully documented

[djhoese]

This also adds documentation for private (_) interfaces including the legacy EWA ones that Satpy still references in its documentation.

[djhoese]

Side note: @pnuu, in the bilinear resampler, there was some warning about the way delayed was used. I didn't understand the exact error message but did notice the Delayed function was a method on the resampler class. This almost always a problem for dask in distributed processing as it means the entire resampler class has to be serialized and sent between nodes. I fixed that by using the slicer function directly. Additionally, in the long run, we need to replace the Delayed usage with a blockwise or map_blocks call with a single large chunk to get around dask not optimizing task graphs with mixed delayed and array usages.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.00%. Comparing base (6525564) to head (a3d1cdf).
⚠️ Report is 36 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #663      +/-   ##
==========================================
+ Coverage   93.99%   94.00%   +0.01%     
==========================================
  Files          89       89              
  Lines       13621    13616       -5     
==========================================
- Hits        12803    12800       -3     
+ Misses        818      816       -2     

Flag	Coverage Δ
unittests	94.00% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coveralls]

coverage: 93.705% (+0.01%) from 93.693%
when pulling a3d1cdf on djhoese:better-api-docs
into 3872224 on pytroll:main.

[Nilzkool]

Hi @djhoese , I noticed you’ve been keeping docs up-to-date, always good to see.

I built a small LLM-based tool for maintaining high-level docs (SDK guides, API references, READMEs, tutorials). It auto-updates them on PRs to prevent drift.

No pressure at all, but thought it might be useful: https://github.com/marketplace/deepdocsai

[pnuu]

@djhoese the bilinear interpolator would also need to be adjusted to work properly with xr.DataArray dimension similar to nearest.