Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readthedocs are missing dependencies #116

Closed
pmav99 opened this issue Nov 30, 2023 · 12 comments
Closed

readthedocs are missing dependencies #116

pmav99 opened this issue Nov 30, 2023 · 12 comments
Assignees

Comments

@pmav99
Copy link

pmav99 commented Nov 30, 2023

E.g. https://ensembleperturbation.readthedocs.io/en/latest/client.html#perturb-tracks

image

There are more similar errors

@SorooshMani-NOAA SorooshMani-NOAA self-assigned this Nov 30, 2023
@SorooshMani-NOAA
Copy link
Collaborator

This issue seems to be due to pooch dependency in adcircpy, but adcircpy already defines pooch as a dependency:
https://github.com/oceanmodeling/adcircpy/blob/main/pyproject.toml

@pmav99 do you have any suggestion as why it's still missing that dependency when generating the documentation?
https://github.com/noaa-ocs-modeling/EnsemblePerturbation/blob/main/.readthedocs.yml

@pmav99
Copy link
Author

pmav99 commented Dec 1, 2023

Not sure. I guess that adding pooch as a dependency will probably fix the issue, but we will still have not understood the underlying issue.

For the record there is another similar error mentioning cartopy which seems to be an optional dependency. I guess that this should be added to the documentation extras, too.

@pmav99
Copy link
Author

pmav99 commented Dec 1, 2023

Hmm... could it be that the adcircpy version you get on readthedocs is a rather old one? I.e. one before pooch became a mandatory deendency of adcircpy?

oceanmodeling/adcircpy@5d3c9e9

@pmav99
Copy link
Author

pmav99 commented Dec 1, 2023

Your readthedocs builds have been failing for the past 20 months, too: https://readthedocs.org/projects/ensembleperturbation/builds/?page=2

@SorooshMani-NOAA
Copy link
Collaborator

Thanks for your comments. I haven't been paying attention to the readthedocs logs! That's a good place to start for me.

@SorooshMani-NOAA
Copy link
Collaborator

@zacharyburnett is ensembleperturbation's readthedoc project still under your account? I can't seem to add it in my rtd projects because of existing project name.

@zacharyburnett
Copy link
Contributor

oh yes, it looks like all of these are failing because of missing dependencies in the extras section; @SorooshMani-NOAA I'll add you as a maintainer as well

@zacharyburnett
Copy link
Contributor

zacharyburnett commented Dec 1, 2023

#117
noaa-ocs-modeling/CoupledModelDriver#161
noaa-ocs-modeling/nemspy#62
oceanmodeling/adcircpy#181

I've made these PRs to add dunamai to the docs dependencies (as per the most recent failing build logs), but I'm still not sure why pooch is not available at runtime to this docs build. It might be that that was the last successful build and thus represents an outdated version of the docs

Sorry about that! I also did not pay attention to the build logs

@pmav99
Copy link
Author

pmav99 commented Dec 1, 2023

It might be that that was the last successful build and thus represents an outdated version of the docs

That's probably the case.

@SorooshMani-NOAA
Copy link
Collaborator

@zacharyburnett thank you, I was the one who should have paid more attention!!

@SorooshMani-NOAA
Copy link
Collaborator

Still after #117 and #119 the issue is not fixed:

Image

I need to add UDUNITS2 as well!

@SorooshMani-NOAA
Copy link
Collaborator

Fixed by #121

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

No branches or pull requests

3 participants