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

[Doc]: Fix xesmf APIs not appearing in the API Reference page of the latest documentation #430

Closed
tomvothecoder opened this issue Mar 9, 2023 · 0 comments · Fixed by #428
Labels
type: docs Updates to documentation

Comments

@tomvothecoder
Copy link
Collaborator

Describe your documentation update

xcdat.regridder.xesmf.XESMFRegridder and xcdat.regridder.horizontal_xesmf are not appearing the API Reference page on main (latest version).

Root Cause

This issue is caused by a change in the Read The Docs build system not having the required dependencies for specific C modules found in ESMF.

Solution

We need to mock "ESMF" imports because xesmf depends on ESMpy which depends on ESMF (has C modules). The Read The Docs build system does not have dependencies for building these C modules which causes a Python ImportError
with xesmf.

@tomvothecoder tomvothecoder added the type: docs Updates to documentation label Mar 9, 2023
@tomvothecoder tomvothecoder changed the title [Doc]: Fix xesmf APIs not appearing the documentation [Doc]: Fix xesmf APIs not appearing in the API Reference page of the latest documentation Mar 9, 2023
@tomvothecoder tomvothecoder changed the title [Doc]: Fix xesmf APIs not appearing in the API Reference page of the latest documentation [Doc]: Fix xesmf APIs not appearing in the API Reference page of the latest documentation Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Updates to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant