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 build silently fails to document Python modules #873

Closed
peanutfun opened this issue Apr 15, 2024 · 1 comment
Closed

readthedocs build silently fails to document Python modules #873

peanutfun opened this issue Apr 15, 2024 · 1 comment

Comments

@peanutfun
Copy link
Member

When trying to import almost any Climada module, the following warning is raised: cannot import name 'colormaps' from 'matplotlib'. Because the modules cannot be imported, their documentation does not appear in the compiled docs, see e.g. https://climada-python.readthedocs.io/en/latest/climada/climada.hazard.html

Maybe we need to upgrade the matplotlib version in the env_docs.yml?

For reference, a full warning message from the rtd build log:

WARNING: autodoc: failed to import module 'hazard.base' from module 'climada'; the following exception was raised:
cannot import name 'colormaps' from 'matplotlib' (/home/docs/checkouts/readthedocs.org/user_builds/climada-python/conda/latest/lib/python3.9/site-packages/matplotlib/__init__.py)
@emanuel-schmid
Copy link
Collaborator

🙌 Thanks for pointing this out. It would have totally escaped my attention for a while.
solved with #687. for good hopefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants