search

r-earthengine / ee_extra

A ninja python package that unifies the Google Earth Engine ecosystem.
https://ee-extra.readthedocs.io/
Other
58 stars 10 forks source link

Broken docs #34

Closed aazuspan closed 2 years ago

aazuspan commented 2 years ago

Hey folks, it looks like all of the Sphinx autosummaries are failing to build, so the latest API reference is empty. Trying to build locally gives a lot of No module named 'ee' warnings.

I've fixed this in a few of my projects by adding autodoc_mock_imports = ["ee"] to docs/conf.py, and that seems to work here, but there's probably a better solution since I think that's just hiding the problem. Any Sphinx pros know how to tackle this the right way?

davemlz commented 2 years ago

This is Extra-weird! (for eemont is working normally)

Thanks for pointing it out, @aazuspan! I will check it :)

davemlz commented 2 years ago

Hey, @aazuspan!

I solved it (https://ee-extra.readthedocs.io/en/latest/modules/stubs/ee_extra.Algorithms.core.panSharpen.html). In case you need the solution for your docs:

Add google-api-core to your docs-requirements.txt file:

https://github.com/r-earthengine/ee_extra/blob/63a74e6f934d000d56701fb4abf00740a7941c9d/docs/docs-requirements.txt#L7

And use a Python >=3.8 for the RTD workflow! :)

https://github.com/r-earthengine/ee_extra/blob/63a74e6f934d000d56701fb4abf00740a7941c9d/readthedocs.yml#L4

Cheers!

Dave

aazuspan commented 2 years ago

Awesome! Thanks for figuring this out and sharing @davemlz. I'll have to make those changes in my projects :)