search

MESMER-group / mesmer

spatially-resolved ESM-specific multi-scenario initial-condition ensemble emulator
https://mesmer-emulator.readthedocs.io/en/latest/
GNU General Public License v3.0
22 stars 15 forks source link

RTD: remove transitive deps from docs env #449

Closed mathause closed 1 month ago

mathause commented 1 month ago

This adds all of our direct dependencies to the docs environment (following #448) but removes the transitive ones. The direct ones were installed before, just not explicitly listed. Unfortunately sphinx (or maybe just the autosummary extension) imports the functions it wants to create the docs for, so they must be installed. However, leaving the optional transitive deps away should lead to a small speed up.

Alternatively we could install everything using pip but that would be more work (c.f. regionmask/regionmask#450)

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.73%. Comparing base (9b0b76b) to head (2969028). Report is 43 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #449 +/- ## ========================================== - Coverage 87.90% 83.73% -4.18% ========================================== Files 40 44 +4 Lines 1745 1949 +204 ========================================== + Hits 1534 1632 +98 - Misses 211 317 +106 ``` | [Flag](https://app.codecov.io/gh/MESMER-group/mesmer/pull/449/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MESMER-group/mesmer/pull/449/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | `83.73% <ø> (-4.18%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

veni-vidi-vici-dormivi commented 1 month ago

Ah another one.

Alternatively we could install everything using pip but that would be more work

Would that remove the need for the docs to have its own yml?

mathause commented 1 month ago

Potentially - we could use the docs extra for the installation, so python -m pip install .[docs]. That's another good reason for switching.

(As long as we don't need any non-python dependency [which was the ultimate problem in regionmask/regionmask#450])

mathause commented 1 month ago

I suggest to merge this and try the pip installation in another PR (see #453)