Skip to content

Add workaround for autodocs failing to handle DataArray - #748

Merged
djhoese merged 1 commit into
pytroll:mainfrom
djhoese:doc-dataarray-workaround
Sep 11, 2026
Merged

Add workaround for autodocs failing to handle DataArray#748
djhoese merged 1 commit into
pytroll:mainfrom
djhoese:doc-dataarray-workaround

Conversation

@djhoese

@djhoese djhoese commented Sep 11, 2026

Copy link
Copy Markdown
Member

Sphinx-autodoc-typehints has trouble when parsing the DataArray import. It issues a warning about the optional xarray dependency "iris" not being available. I could have installed iris, but Claude identified this simpler workaround.

Upstream issue: tox-dev/sphinx-autodoc-typehints#768

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

@djhoese djhoese self-assigned this Sep 11, 2026
@codecov

codecov Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.68%. Comparing base (8aca19c) to head (61f3bae).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #748   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files          89       89           
  Lines       13721    13721           
=======================================
  Hits        12854    12854           
  Misses        867      867           
Flag Coverage Δ
unittests 93.68% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

@djhoese
djhoese merged commit 1ef6503 into pytroll:main Sep 11, 2026
24 of 25 checks passed
@djhoese
djhoese deleted the doc-dataarray-workaround branch September 11, 2026 15:58
@djhoese

djhoese commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

Ugh WTF I merged this because I didn't see any red in CI but it looks like readthedocs didn't run here and is now failing on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant