Skip to content

fix(docs): install phenology extra during docs build#9

Open
ryanpavlick wants to merge 1 commit into
mainfrom
fix/docs-deploy-phenology-extra
Open

fix(docs): install phenology extra during docs build#9
ryanpavlick wants to merge 1 commit into
mainfrom
fix/docs-deploy-phenology-extra

Conversation

@ryanpavlick

Copy link
Copy Markdown
Owner

Docs deploy after v1.10.1 release failed with:

WARNING: Failed guarded type import with ModuleNotFoundError("No module named 'xarray'")
WARNING: Cannot resolve forward reference in type annotations of "hyplan.phenology.fetch_phenology_spatial": name 'xr' is not defined

docs.yml runs Sphinx with -W (treat warnings as errors) and only installed the docs extra. hyplan.phenology imports xarray under a TYPE_CHECKING guard for its annotations, so without xarray the forward-reference warning fires. Adding phenology to the docs install resolves both warnings.

Note: PR-tier CI didn't catch this because docs.yml only triggers on push-to-main, not pull_request. Triggering on PRs is a follow-up improvement.

…uild

Sphinx with -W fails on the forward-reference warning for
hyplan.phenology.fetch_phenology_spatial when xarray isn't installed.
Docs deploy after v1.10.1 release tripped this; PR-tier docs CI didn't
catch it because docs.yml only triggers on push to main.
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.76%. Comparing base (b598751) to head (ffeb892).
⚠️ Report is 1 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #9   +/-   ##
=======================================
  Coverage   80.76%   80.76%           
=======================================
  Files          98       98           
  Lines       13924    13924           
=======================================
  Hits        11246    11246           
  Misses       2678     2678           

☔ 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.

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.

2 participants